Skip to content
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

Jump to bottom

[DPE-4508] Add README #3

Merged
merged 1 commit into from
Jun 20, 2024
Merged

[DPE-4508] Add README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 52 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Charmed Karapace ROCK

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

This repository contains the packaging metadata for creating a Charmed Karapace ROCK.

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.
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
sudo snap install multipass
multipass launch 22.04 -n rock-dev
multipass shell rock-dev
```

### Clone Repository
```bash
git clone https://github.com/canonical/charmed-karapace-rock.git
cd charmed-karapace-rock
```

### Installing Prerequisites
```bash
sudo snap install rockcraft --edge --classic
sudo snap install docker
sudo snap install lxd
sudo snap install skopeo --edge --devmode
```

### Configuring Prerequisites
```bash
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
```bash
rockcraft pack
sudo skopeo --insecure-policy copy oci-archive:charmed-karapace*.rock docker-daemon:<username>/charmed-karapace:<tag>
docker run --rm -it <username>/charmed-karapace:<tag>
```

## License
The Charmed Karapace ROCK is free software, distributed under the Apache
Software License, version 2.0. See
[LICENSE](https://github.com/canonical/charmed-karapace-rock/blob/main/LICENSE)
for more information.
Loading