Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Igor Shishkin <me@teran.dev>
  • Loading branch information
teran committed May 18, 2024
1 parent 2ae6063 commit 7f8fa7d
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,29 @@ but please note a few things:
since they're written and serve for internal purposes.
3. CLI interface (until 1.0.x at least) is also not guaranteed to be stable:
subcommands and options are subjects to change between versions.

## Installation

cephctl is released in following ways to achieve compatibility and provide
an easy way for end users.

### Pre-compiled binary

Pre-compiled binaries are available on per-release basis and provided on
[GitHub Releases page](https://github.com/teran/cephctl/releases). Automatically
generated changelog is available for each release.

### Container image

Since cephctl uses ceph binary to achieve cluster data container image based
on ceph official release image is also available. This image is designed as
drop-in replacement for official ceph image to use for `cephadm shell` command.

### Build from source

It's possible to build cephctl from source by simply running the follwoing
command:

```shell
go build -o dist/cephctl ./cmd/cephctl/...
```

0 comments on commit 7f8fa7d

Please sign in to comment.