Skip to content

Commit

Permalink
chore: fix rocks terminology (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdcordeiro authored May 24, 2024
1 parent 0e79bc5 commit e112541
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Charmed PostgreSQL ROCK
# Charmed PostgreSQL rock
[![Release to GHCR](https://github.com/canonical/charmed-postgresql-rock/actions/workflows/release.yaml/badge.svg)](https://github.com/canonical/charmed-postgresql-rock/actions/workflows/release.yaml)

This repository contains the packaging metadata for creating a ROCK of PostgreSQL built from the official Ubuntu repositories. For more information on ROCKs, visit the [rockcraft Github](https://github.com/canonical/rockcraft).
This repository contains the packaging metadata for creating a rock of PostgreSQL built from the official Ubuntu repositories. 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.
## 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.

### Clone Repository
```bash
Expand All @@ -24,15 +24,15 @@ 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-postgresql*.rock docker-daemon:<username>/charmed-postgresql:<tag>
docker run --rm -it <username>/charmed-postgresql:<tag>
```

## License
The PostgreSQL ROCK is free software, distributed under the Apache
The PostgreSQL rock is free software, distributed under the Apache
Software License, version 2.0. See
[LICENSE](https://github.com/canonical/charmed-postgresql-rock/blob/14-22.04/licenses/LICENSE-rock)
for more information.
4 changes: 2 additions & 2 deletions rockcraft.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: charmed-postgresql
base: [email protected]
version: '14.11'
summary: PostgreSQL in a ROCK.
summary: PostgreSQL in a rock.
description: |
The PostgreSQL ROCK is created using the
The PostgreSQL rock is created using the
charmed-postgresql-snap and includes all of the
components needed to run PostgreSQL in your Kubernetes
cluster.
Expand Down

0 comments on commit e112541

Please sign in to comment.