Skip to content

Commit

Permalink
chore: fix rocks terminology (#92)
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
cjdcordeiro authored Jun 6, 2024
1 parent 60d00d0 commit 5a3d6ea
Show file tree
Hide file tree
Showing 15 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build_and_publish_rock.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# reusable workflow for publishing a ROCK
# reusable workflow for publishing a rock
name: Build and publish rock

on:
Expand Down Expand Up @@ -29,7 +29,7 @@ on:

jobs:
build-publish-rock:
name: Build and publish ROCK
name: Build and publish rock
uses: canonical/charmed-kubeflow-workflows/.github/workflows/build_and_publish_rock.yaml@main
with:
rock-dir: ${{ inputs.rock-dir }}
Expand Down
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
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Kubeflow ROCKs
# Kubeflow Rocks

Collection of ROCKs for Kubeflow components.
Collection of [rocks](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/) for Kubeflow components.

# Development notes
- Rockcraft tutorial:
Expand All @@ -12,16 +12,16 @@ Collection of ROCKs for Kubeflow components.
- Use `build-packages` and `build-snaps` for build stage. Those will not be used by application. As a result, if build and application require the same package, it needs to be in both `build-packages` and `stage-packages`
- If issues with LXD/Docker arise review firewall setup:
https://linuxcontainers.org/lxd/docs/master/howto/network_bridge_firewalld/
- While building ROCKs these commands are very helpful:
- While building rocks these commands are very helpful:
```
rockcraft clean
lxc --project rockcraft image list
```
- Entry point in ROCK is Pebble. At this point there is no way to specify other entry point. To start container, a Pebble layer is added via adding `001-deafault.yaml` file to `/var/lib/pebble/default/layers/`. Refer to source code for more details.
- The rock's entrypoint is [Pebble](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/pebble/). At this point, there is no way to specify other entrypoint. A Pebble layer is added via adding the `001-deafault.yaml` file to `/var/lib/pebble/default/layers/` (Rockcraft does that). Refer to source code for more details.

# Building ROCKs
# Building Rocks

To build ROCK images for Kubeflow components:
To build rocks for Kubeflow components:
```
cd <image-directory>
rockcraft pack
Expand Down
2 changes: 1 addition & 1 deletion centraldashboard/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def test_rock(rock_test_env):
rock_version = check_rock.get_version()
LOCAL_ROCK_IMAGE = f"{rock_image}:{rock_version}"

# create ROCK filesystem
# create rock filesystem
subprocess.run(
[
"docker",
Expand Down
2 changes: 1 addition & 1 deletion jupyter-pytorch-cuda-full/rockcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ parts:
cp -r "${CONDA_DIR}" "${CRAFT_PART_INSTALL}/opt/conda"
cp -r "${HOME}" "${CRAFT_PART_INSTALL}/${HOME}"
# not-root user for this ROCK should be 'jovyan'
# not-root user for this rock should be 'jovyan'
non-root-user:
plugin: nil
after: [conda-jupyter]
Expand Down
2 changes: 1 addition & 1 deletion jupyter-pytorch-cuda-full/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def test_rock(ops_test: OpsTest):
rock_image = f"{name}_{rock_version}_{arch}"
LOCAL_ROCK_IMAGE = f"{rock_image}:{rock_version}"

# verify ROCK service
# verify rock service
rock_services = rock["services"]
assert rock_services["jupyter"]
assert rock_services["jupyter"]["startup"] == "enabled"
Expand Down
2 changes: 1 addition & 1 deletion jupyter-pytorch-full/rockcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ parts:
cp -r "${CONDA_DIR}" "${CRAFT_PART_INSTALL}/opt/conda"
cp -r "${HOME}" "${CRAFT_PART_INSTALL}/${HOME}"
# not-root user for this ROCK should be 'jovyan'
# not-root user for this rock should be 'jovyan'
non-root-user:
plugin: nil
after: [conda-jupyter]
Expand Down
2 changes: 1 addition & 1 deletion jupyter-pytorch-full/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def test_rock():
rock_services = check_rock.get_services()
LOCAL_ROCK_IMAGE = f"{rock_image}:{rock_version}"

# verify ROCK service
# verify rock service
assert rock_services["jupyter"]
assert rock_services["jupyter"]["startup"] == "enabled"

Expand Down
2 changes: 1 addition & 1 deletion jupyter-scipy/rockcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ parts:
cp -r "${CONDA_DIR}" "${CRAFT_PART_INSTALL}/opt/conda"
cp -r "${HOME}" "${CRAFT_PART_INSTALL}/${HOME}"
# not-root user for this ROCK should be 'jovyan'
# not-root user for this rock should be 'jovyan'
non-root-user:
plugin: nil
after: [conda-jupyter]
Expand Down
2 changes: 1 addition & 1 deletion jupyter-scipy/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def test_rock(ops_test: OpsTest):
rock_image = f"{name}_{rock_version}_{arch}"
LOCAL_ROCK_IMAGE = f"{rock_image}:{rock_version}"

# verify ROCK service
# verify rock service
rock_services = rock["services"]
assert rock_services["jupyter"]
assert rock_services["jupyter"]["startup"] == "enabled"
Expand Down
2 changes: 1 addition & 1 deletion jupyter-tensorflow-cuda-full/rockcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ parts:
cp -rp "${CONDA_DIR}" "${CRAFT_PART_INSTALL}/opt/conda"
cp -rp "${HOME}" "${CRAFT_PART_INSTALL}/${HOME}"
# not-root user for this ROCK should be 'jovyan'
# not-root user for this rock should be 'jovyan'
non-root-user:
plugin: nil
after: [conda-jupyter]
Expand Down
2 changes: 1 addition & 1 deletion jupyter-tensorflow-cuda-full/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def test_rock(ops_test: OpsTest):
rock_image = f"{name}_{rock_version}_{arch}"
LOCAL_ROCK_IMAGE = f"{rock_image}:{rock_version}"

# verify ROCK service
# verify rock service
rock_services = rock["services"]
assert rock_services["jupyter"]
assert rock_services["jupyter"]["startup"] == "enabled"
Expand Down
2 changes: 1 addition & 1 deletion jupyter-tensorflow-full/rockcraft.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ parts:
cp -r "${CONDA_DIR}" "${CRAFT_PART_INSTALL}/opt/conda"
cp -r "${HOME}" "${CRAFT_PART_INSTALL}/${HOME}"
# not-root user for this ROCK should be 'jovyan'
# not-root user for this rock should be 'jovyan'
non-root-user:
plugin: nil
after: [conda-jupyter]
Expand Down
2 changes: 1 addition & 1 deletion jupyter-tensorflow-full/tests/test_rock.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def test_rock(ops_test: OpsTest):
rock_image = f"{name}_{rock_version}_{arch}"
LOCAL_ROCK_IMAGE = f"{rock_image}:{rock_version}"

# verify ROCK service
# verify rock service
rock_services = rock["services"]
assert rock_services["jupyter"]
assert rock_services["jupyter"]["startup"] == "enabled"
Expand Down

0 comments on commit 5a3d6ea

Please sign in to comment.