ceph/cn — 235★ on GitHub (Go). Ceph Nano - One step S3 in container with Ceph.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
⚠️ This project is no longer maintained. 😢 Feel free to fork or explore alternatives.
Old README
cn (ceph-nano)
The project
cn is a little program written in Go that helps you interact with the S3 API by providing a REST S3 compatible gateway. The target audience is developers building their applications on Amazon S3. It is also an exciting tool to showcase Ceph Rados Gateway S3 compatibility.
This is brought to you by the power of Ceph and Containers. Under the hood, cn runs a Ceph container and exposes a Rados Gateway. For convenience, cn also comes with a set of commands to work with the S3 gateway. Before you ask "why not using s3cmd instead?", then you will be happy to read that internally cn uses s3cmd and act as a wrapper around the most commonly used commands.
Also, keep in mind that the CLI is just for convenience, and the primary use case is you developing your application directly on the S3 API.
Table of contents
Build
Installation
Get started
Selecting the cluster flavor
Your first S3 bucket
Multi-cluster support
List Ceph container images available
Using images aliases
Enable mgr dashboard
Build
You can build cn by using make.
Be sure dep is installed:
$ go get github.com/golang/dep/cmd/dep
Then, add ~/go/bin to your $PATH:
$ export PATH=$PATH:~/go/bin
Build cn:
$ make
rm -f cn cn &>/dev/null || true
dep ensure
GOOS=linux GOARCH=amd64 go build -i -ldflags="-X main.version=cea247c-dirty -X main.tag=devel -X main.branch=guits-doc_build" -o cn-devel-cea247c-dirty-linux-amd64 main.go
ln -sf "cn-devel-cea247c-dirty-linux-amd64" cn
Once the build is done, you should have a symlink cn pointing to the binary that just got built:
$ ./cn
Ceph Nano - One step S3 in container with Ceph.
*(((((((((((((
(((((((((((((((((((
((((((((* ,(((((((*
(((((( ((((((
*((((, ,((((/
((((, ((((((/ *((((
(((( ((((((((( ((((
/((( ((((((((( ((((
(((. ((((((( /(((/
((( *((((
.((( (((((
,(((((((* /(((
.((((( ((( (/ // (((
/(((. /((((( /(((((
.((((/ (/
Usage:
cn [command]
Available Commands:
cluster Interact with a particular Ceph cluster
s3 Interact with a particular S3 object server
image Interact with cn's container image(s)
version Print the version of cn
kube Outputs cn kubernetes template (cn kube > kube-cn.yml)
update-check Print cn current and latest version number
flavors Interact with flavors
completion Generates bash completion scripts
Flags:
-h, --help help for cn
Use "cn [command] --help" for more information about a command.
Get started
Start the program with a working directory /tmp, the initial start might take a few minutes since we need to download the container image:
$ ./cn cluster start -d /tmp my-first-cluster
Running ceph-nano...
The container image is not present, pulling it.
This operation can take a few minutes......................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................
Endpoint: http://10.36.116.164:8000
Dashboard: http://10.36.116.164:5001
Access key is: 9ZU1QBYX13KPLXXDDCY2
Secret key is: nthNG1xb7ta5IDKiJKM8626pQitqsalEo0ta7B9E
Working directory: /usr/share/ceph-nano
Selecting the cluster flavor
Is it possible to select the cluster flavor by using the -f option on the command line.
$ ./cn cluster start mycluster -f huge
The full documentation of flavors can be found here
Your first S3 bucket
Create a bucket with cn:
$ ./cn s3 mb my-first-cluster my-buc
Bucket 's3://my-buc/' created
$ ./cn s3 put my-first-cluster /etc/passwd my-buc
upload: '/tmp/passwd' -> 's3://my-buc/passwd' [1 of 1]
5925 of 5925 100% in 1s 4.57 kB/s done
Multi-cluster support
cn can manage any number of clusters on your local machine:
$ ./cn cluster ls
+------+---------+-------------------------------------------------------------------------------------+----------------+--------------------------------+---------+
| NAME | STATUS | IMAGE | IMAGE RELEASE | IMAGE CREATION TIME | FLAVOR |
+------+---------+-------------------------------------------------------------------------------------+----------------+--------------------------------+---------+
| d | running | ceph/daemon:latest | master-77e3d8d | 2018-04-05T15:01:40.323603472Z | default |
| b | running | ceph/daemon@sha256:369867e450ccdea9bcea7f54e97ed8b2cb1a0437fbef658d2d01fce2b8a2c648 | master-5f44af9 | 2018-03-30T21:08:31.117367166Z | medium |
+------+---------+-------------------------------------------------------------------------------------+----------------+--------------------------------+---------+
List Ceph container images available
cn can list the available Ceph container images, the default output shows the 100 first images:
The image option (-i) support aliases to simply the command line.
It is possible to list the aliases by running the image show-aliases command as per below :
Aliases can be use in place of the traditional image name as per the following example:
$ ./cn cluster start mycluster -i mimic
It is also possible to create new aliases as detailed here
Enable mgr dashboard
TODO: This is a temporary hack to enable the manager dashboard
Currently cn does not expose a port for the mgr dashboard.
It only exposes port 8000 for S3 API, and port 5000 for Sree - S3 web client.
To expose also the mgr dashboard port we currently have to do some hacks.
This section will guide you how to manually commit a new image and then run a new container with the desired expose ports.
The most recent commit recorded on ceph/cn was 1.5 years ago, based on the GitHub push timestamp. The repository has 25 forks — one of the better signals of community interest.
How does ceph/cn compare to other Backend projects?
ceph/cn is tracked by TopGit in the Backend category, with 235 GitHub stars and written in Go. Browse the Backend topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does ceph/cn have?
ceph/cn has 235 GitHub stars — refresh the page for the live number, or check github.com/ceph/cn. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is ceph/cn open source?
Yes — ceph/cn ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/ceph/cn.
What is ceph/cn?
ceph/cn (ceph/cn) is a Go project on GitHub. From the project's own README: Ceph Nano - One step S3 in container with Ceph.
Where do I read more about ceph/cn?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/ceph/cn is the definitive source.
Read full README in the tab above.
Still deciding about cn?
One click hands the question to an AI along with this page — see what it says about cn.