Skip to content

Commit

Permalink
chore: fix rocks terminology
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdcordeiro committed May 23, 2024
1 parent 729f960 commit 34d6f9a
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 16 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build ROCK
name: Build rock

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down Expand Up @@ -38,15 +38,15 @@ jobs:
run: |
sudo snap install yq
sudo snap install rockcraft --classic --edge
- name: Build ROCK
- name: Build rock
id: build
run: |
rockcraft pack --verbose
VERSION=$(yq '.version' rockcraft.yaml)
echo "rock=charmed-kafka_${VERSION}_amd64.rock" >> $GITHUB_OUTPUT
- name: Upload locally built ROCK artifact
- name: Upload locally built rock artifact
uses: actions/upload-artifact@v3
with:
name: charmed-kafka
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish ROCK
name: Publish rock
on:
push:
branches:
Expand All @@ -22,7 +22,7 @@ jobs:
echo "track=${BRANCH%*\/*}" >> $GITHUB_OUTPUT
id: branch_metadata

- name: Extract ROCK metadata
- name: Extract rock metadata
shell: bash
run: |
VERSION=$(yq '(.version|split("-"))[0]' rockcraft.yaml)
Expand Down
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Charmed Kafka ROCK
# Charmed Kafka rock

[![Container Registry](https://img.shields.io/badge/Container%20Registry-published-blue)](https://github.com/canonical/charmed-kafka-rock/pkgs/container/charmed-kafka)
[![Release](https://github.com/canonical/charmed-kafka-rock/actions/workflows/publish.yaml/badge.svg)](https://github.com/canonical/charmed-kafka-rock/actions/workflows/publish.yaml)

This repository contains the packaging metadata for creating a Charmed Kafka ROCK. This ROCK image is based on the [Charmed Kafka Snap](https://github.com/canonical/charmed-kafka-snap)
This repository contains the packaging metadata for creating a Charmed Kafka rock. This rock image is based on the [Charmed Kafka Snap](https://github.com/canonical/charmed-kafka-snap)

For more information on ROCKs, visit the [rockcraft Github](https://github.com/canonical/rockcraft).
For more information on rocks, visit the [rockcraft Github](https://github.com/canonical/rockcraft).

## Building the ROCK
The steps outlined below are based on the assumption that you are building the ROCK with the latest LTS of Ubuntu.
## Building the rock

The steps outlined below are based on the assumption that you are building the rock with the latest LTS of Ubuntu.
If you are using another version of Ubuntu or another operating system, the process may be different.
To avoid any issue with other operating systems you can simply build the image with [multipass](https://multipass.run/):
```bash
Expand All @@ -35,14 +36,16 @@ sudo usermod -aG docker $USER
sudo lxd init --auto
```
*_NOTE:_* You will need to open a new shell for the group change to take effect (i.e. `su - $USER`)
### Packing and Running the ROCK

### Packing and Running the rock

```bash
rockcraft pack
sudo skopeo --insecure-policy copy oci-archive:charmed-kafka*.rock docker-daemon:<username>/charmed-kafka:<tag>
docker run --rm -it <username>/charmed-kafka:<tag>
```
## License
The Charmed Kafka ROCK is free software, distributed under the Apache
The Charmed Kafka rock is free software, distributed under the Apache
Software License, version 2.0. See
[LICENSE](https://github.com/canonical/charmed-kafka-rock/blob/main/LICENSE)
for more information.
8 changes: 4 additions & 4 deletions rockcraft.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Copyright 2023 Canonical Ltd.
# See LICENSE file for licensing details.
---
name: charmed-kafka # the name of your ROCK
base: [email protected] # the base environment for this ROCK
name: charmed-kafka # the name of your rock
base: [email protected] # the base environment for this rock
version: '3.6.1' # just for humans. Semantic versioning is recommended
summary: Charmed Kafka ROCK OCI # 79 char long summary
summary: Charmed Kafka rock OCI # 79 char long summary
description: |
This is an OCI image that bundles Apache Kafka together with other tools
of its ecosystem in order to be used in Charmed Operators, providing
Expand All @@ -14,7 +14,7 @@ description: |
cloud native technologies.
license: Apache-2.0 # your application's SPDX license

platforms: # The platforms this ROCK should be built on and run on
platforms: # The platforms this rock should be built on and run on
amd64:

services:
Expand Down

0 comments on commit 34d6f9a

Please sign in to comment.