From 34cad82a8a65170aee905985969b0e38421fee45 Mon Sep 17 00:00:00 2001 From: Cristovao Cordeiro Date: Mon, 15 Jul 2024 09:44:40 +0200 Subject: [PATCH] chore: fix rocks terminology (#34) --- .github/workflows/build.yaml | 6 +++--- .github/workflows/publish.yaml | 2 +- .github/workflows/publish_beta.yaml | 2 +- README.md | 31 +++++++++++++++-------------- rockcraft.yaml | 6 +++--- 5 files changed, 24 insertions(+), 23 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 43e5ac3..b31ae13 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,4 +1,4 @@ -name: Build ROCK +name: Build rock on: workflow_call: @@ -17,10 +17,10 @@ jobs: sudo snap install yq sudo snap install rockcraft --classic --channel=latest/stable --revision 1206 sudo snap install charmcraft --classic --revision 1349 - - name: Build ROCK + - name: Build rock run: | rockcraft pack - - name: Upload locally built ROCK artifact + - name: Upload locally built rock artifact uses: actions/upload-artifact@v3 with: name: mongodb-rock diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index b2bec9a..886a586 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -1,4 +1,4 @@ -name: Publish ROCK (edge) +name: Publish rock (edge) on: push: branches: diff --git a/.github/workflows/publish_beta.yaml b/.github/workflows/publish_beta.yaml index 272daed..251a001 100644 --- a/.github/workflows/publish_beta.yaml +++ b/.github/workflows/publish_beta.yaml @@ -1,4 +1,4 @@ -name: Publish ROCK (beta) +name: Publish rock (beta) on: workflow_dispatch jobs: diff --git a/README.md b/README.md index 5686e91..3713fe4 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,36 @@ -## Introduction to Charmed MongoDB ROCK (OCI Image) -[![Publish ROCK](https://github.com/canonical/charmed-mongodb-rock/actions/workflows/publish.yaml/badge.svg)](https://github.com/canonical/charmed-mongodb-rock/actions/workflows/publish.yaml) +## Introduction to Charmed MongoDB rock (OCI Image) +[![Publish rock](https://github.com/canonical/charmed-mongodb-rock/actions/workflows/publish.yaml/badge.svg)](https://github.com/canonical/charmed-mongodb-rock/actions/workflows/publish.yaml) [![Operator Tests](https://github.com/canonical/charmed-mongodb-rock/actions/workflows/integration.yaml/badge.svg)](https://github.com/canonical/charmed-mongodb-rock/actions/workflows/integration.yaml) [MongoDB](https://github.com/mongodb/mongo) is a source-available, cross-platform, document-oriented database application. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas. -Charmed MongoDB ROCK is an Open Container Initiative (OCI) image derived from the [Charmed MongoDB Snap](https://snapcraft.io/charmed-mongodb). The tool used to create this ROCK is called [Rockcraft](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/index.html). +Charmed MongoDB rock is an Open Container Initiative (OCI) image derived from the [Charmed MongoDB Snap](https://snapcraft.io/charmed-mongodb). The tool used to create this rock is called [Rockcraft](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/index.html). -The [Charmed MongoDB ROCK](https://github.com/canonical/charmed-mongodb-rock/pkgs/container/charmed-mongodb) is an enhanced, source-available, fully-compatible, drop-in replacement of the OCI image of MongoDB 6.0.6 Community version. In addition, the Charmed MongoDB ROCK package offers more features than the MongoDB Community version, such as backup and restore, monitoring and security features. +The [Charmed MongoDB rock](https://github.com/canonical/charmed-mongodb-rock/pkgs/container/charmed-mongodb) is an enhanced, source-available, fully-compatible, drop-in replacement of the OCI image of MongoDB 6.0.6 Community version. In addition, the Charmed MongoDB rock package offers more features than the MongoDB Community version, such as backup and restore, monitoring and security features. -One benefit of using the Charmed MongoDB ROCK is that it bundles MongoDB with other tools in its ecosystem to be used in the Charmed MongoDB Operator. One of the operators that uses this ROCK is the [Charmed MongoDB (Kubernetes Operator)](https://charmhub.io/mongodb-k8s). +One benefit of using the Charmed MongoDB rock is that it bundles MongoDB with other tools in its ecosystem to be used in the Charmed MongoDB Operator. One of the operators that uses this rock is the [Charmed MongoDB (Kubernetes Operator)](https://charmhub.io/mongodb-k8s). The Charmed MongoDB (Kubernetes Operator) delivers automated operations management from day 0 to day 2 on the[ ](https://github.com/mongodb/mongo)MongoDB document database. Charmed MongoDB (K8s Operator) is an enhanced, open source and fully-compatible, drop-in replacement for the MongoDB Community Edition with advanced MongoDB enterprise features. You can use the operator to manage your MongoDB clusters with automation capabilities. In addition, it provides automated database operations on a wide range of cloud and cloud-like environments, including AWS, Azure, OpenStack and VMWare. ## Version -ROCKs will be named as `-_`. +Rocks will be named as `-_`. -`` is the software version; `` is the Ubuntu LTS series that ROCKs supports; and the is the type of release, if it is edge, candidate or stable. Example versioning will be 5-22.04_stable which means Charmed MongoDB is a version 5 of the software, supporting the 22.04 Ubuntu release and currently a 'stable' version of the software. See versioning details [here](https://snapcraft.io/docs/channels). +`` is the software version; `` is the Ubuntu LTS series that rocks supports; and the is the type of release, if it is edge, candidate or stable. Example versioning will be 5-22.04_stable which means Charmed MongoDB is a version 5 of the software, supporting the 22.04 Ubuntu release and currently a 'stable' version of the software. See versioning details [here](https://snapcraft.io/docs/channels). Channel can also be represented by combining `_` ## Release -Charmed MongoDB ROCK Release Notes +Charmed MongoDB rock Release Notes https://discourse.charmhub.io/t/release-notes-charmed-mongodb-5-rock/10038 -## ROCKS Usage +## Rocks Usage ### Starting mongod and accessing the database -To get started with the charmed-mongodb ROCKS, first install docker: +To get started with the charmed-mongodb rocks, first install docker: ``` sudo snap install docker ``` -Then to use the Charmed MongoDB ROCK run the following command +Then to use the Charmed MongoDB rock run the following command ``` sudo docker run --rm -it ghcr.io/canonical/charmed-mongodb:6.0.6-22.04_edge ``` @@ -62,7 +62,7 @@ While using `mongo` can run a variety of [database commands](https://www.mongodb ### Backup and restore -Percona Backup for MongoDB (`pbm`) is packaged within the Charmed MongoDB ROCK. To use it you can follow these instructions. +Percona Backup for MongoDB (`pbm`) is packaged within the Charmed MongoDB rock. To use it you can follow these instructions. Percona Backup for MongoDB has a set of pre-requisites, to function properly. These can be found here:[ https://docs.percona.com/percona-backup-mongodb/initial-setup.html](https://docs.percona.com/percona-backup-mongodb/initial-setup.html) @@ -99,8 +99,9 @@ Check out the rest of the supported operations with: docker exec pbm --help ``` -### Others tools within the ROCK -The MongoDB ROCK also packages other useful tools like `mongodb-exporter`, `mongodump`, `mongorestore`, and many other tools. You can read more about the tools packaged in the snap by entering: +### Others tools within the rock + +The MongoDB rock also packages other useful tools like `mongodb-exporter`, `mongodump`, `mongorestore`, and many other tools. You can read more about the tools packaged in the snap by entering: ``` docker exec --help` ``` @@ -108,7 +109,7 @@ docker exec --help` ## Bugs and feature request -If you find a bug in this ROCK or want to request a specific feature, here are the useful links: +If you find a bug in this rock or want to request a specific feature, here are the useful links: - Raise the issue or feature request in the [Canonical Github](https://github.com/canonical/charmed-mongodb-rock/issues) diff --git a/rockcraft.yaml b/rockcraft.yaml index 95d47d7..e281880 100644 --- a/rockcraft.yaml +++ b/rockcraft.yaml @@ -1,7 +1,7 @@ # Copyright 2023 Canonical Ltd. # See LICENSE file for licensing details. -name: charmed-mongodb # the name of your ROCK -base: ubuntu@22.04 # the base environment for this ROCK +name: charmed-mongodb # the name of your rock +base: ubuntu@22.04 # the base environment for this rock version: "6.0.6-2" # just for humans. Semantic versioning is recommended summary: MongoDB in a rock. # 79 char long summary description: | @@ -19,7 +19,7 @@ services: command: "/bin/bash /bin/start.sh" -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: parts: