Skip to content

Commit

Permalink
chore: replace ROCKs with rocks
Browse files Browse the repository at this point in the history
This commit replaces ROCKs with rocks to be in sync with Canonical's standard terminology.

Part of canonical/bundle-kubeflow#916
  • Loading branch information
DnPlas committed Jun 6, 2024
1 parent da879fc commit 1056462
Show file tree
Hide file tree
Showing 20 changed files with 60 additions and 60 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/on_pull_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
jobs:

on-pull-request:
name: Get ROCKs modified and build-scan-test them
name: Get rocks modified and build-scan-test them
uses: canonical/charmed-kubeflow-workflows/.github/workflows/get-rocks-modified-and-build-scan-test-publish.yaml@main
permissions:
pull-requests: read
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/on_push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
jobs:

on-push:
name: Get ROCKs modified and build-scan-test-publish them
name: Get rocks modified and build-scan-test-publish them
uses: canonical/charmed-kubeflow-workflows/.github/workflows/get-rocks-modified-and-build-scan-test-publish.yaml@main
permissions:
pull-requests: read
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ The KServe server images are a collection of different inference server runtimes

The Dockerfile for each of these images takes advantage of how each server is defined as a poetry package, using `poetry install` in the Dockerfile directly.

## Implementation details of the ROCKs in this repo
## Implementation details of the rocks in this repo

The ROCKs for the KServe servers require some atypical workarounds, mostly due to the upstream project using poetry to install its dependencies. These are documented here in detail, and briefly noted in the rockcraft.yaml files in this repository.
The rocks for the KServe servers require some atypical workarounds, mostly due to the upstream project using poetry to install its dependencies. These are documented here in detail, and briefly noted in the rockcraft.yaml files in this repository.

### Installing Python/pip via overlay-packages

Expand Down Expand Up @@ -70,4 +70,4 @@ The upstream install procedure results in `python` being executable, but our roc

## Integration testing the server images

For every inference server provided, upstream maintains an example usage in their [Model Serving Runtimes docs](https://kserve.github.io/website/master/modelserving/v1beta1/serving_runtime/). Each example includes a model for the given server, sample input, and an example `curl` call. These can be used for integration testing of the models without deploying KServe. See also the `README.md` files in the subdirs of this repo for some of these examples applied to our ROCKs.
For every inference server provided, upstream maintains an example usage in their [Model Serving Runtimes docs](https://kserve.github.io/website/master/modelserving/v1beta1/serving_runtime/). Each example includes a model for the given server, sample input, and an example `curl` call. These can be used for integration testing of the models without deploying KServe. See also the `README.md` files in the subdirs of this repo for some of these examples applied to our rocks.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# kserve-rocks
ROCKs for Kserve
rocks for Kserve
6 changes: 3 additions & 3 deletions agent/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ def 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}"
LOCAL_rock_IMAGE = f"{rock_image}:{rock_version}"

# assert the rock contains the expected files
subprocess.run(
[
"docker",
"run",
"--rm",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"exec",
"ls",
"-la",
Expand All @@ -35,7 +35,7 @@ def test_rock():
"docker",
"run",
"--rm",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"exec",
"ls",
"-la",
Expand Down
6 changes: 3 additions & 3 deletions agent/tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ commands =
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" && \
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'
echo "Exporting $rock to docker as $DOCKER_IMAGE" && \
skopeo --insecure-policy copy oci-archive:$rock docker-daemon:$DOCKER_IMAGE'

[testenv:sanity]
passenv = *
Expand Down
6 changes: 3 additions & 3 deletions controller/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ def 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}"
LOCAL_rock_IMAGE = f"{rock_image}:{rock_version}"

# assert the rock contains the expected files
subprocess.run(
[
"docker",
"run",
"--rm",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"exec",
"ls",
"-la",
Expand All @@ -31,6 +31,6 @@ def test_rock():
)

subprocess.run(
["docker", "run", "--rm", LOCAL_ROCK_IMAGE, "exec", "ls", "-la", "/manager"],
["docker", "run", "--rm", LOCAL_rock_IMAGE, "exec", "ls", "-la", "/manager"],
check=True,
)
6 changes: 3 additions & 3 deletions controller/tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ commands =
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" && \
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'
echo "Exporting $rock to docker as $DOCKER_IMAGE" && \
skopeo --insecure-policy copy oci-archive:$rock docker-daemon:$DOCKER_IMAGE'

[testenv:sanity]
passenv = *
Expand Down
8 changes: 4 additions & 4 deletions lgbserver/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def test_rock(rock_test_env):
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}"
LOCAL_rock_IMAGE = f"{rock_image}:{rock_version}"

# assert we have the expected files
subprocess.run(
Expand All @@ -40,7 +40,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /usr/local/lib/python3.10/dist-packages/lgbserver",
],
Expand All @@ -52,7 +52,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /usr/local/lib/python3.10/dist-packages/kserve",
],
Expand All @@ -64,7 +64,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /third_party",
],
Expand Down
6 changes: 3 additions & 3 deletions lgbserver/tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ commands =
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" && \
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'
echo "Exporting $rock to docker as $DOCKER_IMAGE" && \
skopeo --insecure-policy copy oci-archive:$rock docker-daemon:$DOCKER_IMAGE'

[testenv:sanity]
passenv = *
Expand Down
8 changes: 4 additions & 4 deletions paddleserver/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def test_rock(rock_test_env):
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}"
LOCAL_rock_IMAGE = f"{rock_image}:{rock_version}"

# assert we have the expected files
subprocess.run(
Expand All @@ -45,7 +45,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /usr/local/lib/python3.10/dist-packages/paddleserver",
],
Expand All @@ -57,7 +57,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /usr/local/lib/python3.10/dist-packages/kserve",
],
Expand All @@ -69,7 +69,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /third_party",
],
Expand Down
6 changes: 3 additions & 3 deletions paddleserver/tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ commands =
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" && \
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'
echo "Exporting $rock to docker as $DOCKER_IMAGE" && \
skopeo --insecure-policy copy oci-archive:$rock docker-daemon:$DOCKER_IMAGE'

[testenv:sanity]
passenv = *
Expand Down
8 changes: 4 additions & 4 deletions pmmlserver/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def test_rock(rock_test_env):
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}"
LOCAL_rock_IMAGE = f"{rock_image}:{rock_version}"

# assert we have the expected files
subprocess.run(
Expand All @@ -45,7 +45,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /usr/local/lib/python3.10/dist-packages/pmmlserver",
],
Expand All @@ -57,7 +57,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /usr/local/lib/python3.10/dist-packages/kserve",
],
Expand All @@ -69,7 +69,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /third_party",
],
Expand Down
6 changes: 3 additions & 3 deletions pmmlserver/tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ commands =
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" && \
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'
echo "Exporting $rock to docker as $DOCKER_IMAGE" && \
skopeo --insecure-policy copy oci-archive:$rock docker-daemon:$DOCKER_IMAGE'

[testenv:sanity]
passenv = *
Expand Down
8 changes: 4 additions & 4 deletions sklearnserver/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def test_rock(rock_test_env):
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}"
LOCAL_rock_IMAGE = f"{rock_image}:{rock_version}"

# assert we have the expected files
subprocess.run(
Expand All @@ -45,7 +45,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /usr/local/lib/python3.10/dist-packages/sklearnserver",
],
Expand All @@ -57,7 +57,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /usr/local/lib/python3.10/dist-packages/kserve",
],
Expand All @@ -69,7 +69,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /third_party",
],
Expand Down
6 changes: 3 additions & 3 deletions sklearnserver/tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ commands =
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" && \
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'
echo "Exporting $rock to docker as $DOCKER_IMAGE" && \
skopeo --insecure-policy copy oci-archive:$rock docker-daemon:$DOCKER_IMAGE'

[testenv:sanity]
passenv = *
Expand Down
8 changes: 4 additions & 4 deletions storage-initializer/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def test_rock(rock_test_env):
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}"
LOCAL_rock_IMAGE = f"{rock_image}:{rock_version}"

# assert we have the expected files
subprocess.run(
Expand All @@ -40,7 +40,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /usr/local/lib/python3.10/dist-packages/kserve",
],
Expand All @@ -52,7 +52,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /third_party",
],
Expand All @@ -64,7 +64,7 @@ def test_rock(rock_test_env):
"run",
"--entrypoint",
"/bin/bash",
LOCAL_ROCK_IMAGE,
LOCAL_rock_IMAGE,
"-c",
"ls -la /storage-initializer/scripts/initializer-entrypoint",
],
Expand Down
6 changes: 3 additions & 3 deletions storage-initializer/tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ commands =
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" && \
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'
echo "Exporting $rock to docker as $DOCKER_IMAGE" && \
skopeo --insecure-policy copy oci-archive:$rock docker-daemon:$DOCKER_IMAGE'

[testenv:sanity]
passenv = *
Expand Down
Loading

0 comments on commit 1056462

Please sign in to comment.