|
1 |
| -# Build the management |
| 1 | +beegfs-rust <!-- omit in toc --> |
| 2 | +=========== |
2 | 3 |
|
3 |
| -1. Read through [Getting started with Rust](https://github.com/ThinkParQ/beegfs-rs/wiki/Getting-Started-with-Rust) and setup your environment as described. |
| 4 | +# Contents <!-- omit in toc --> |
4 | 5 |
|
5 |
| -2. Clone the management repository: |
| 6 | +- [Getting Started](#getting-started) |
| 7 | + - [Prerequisites](#prerequisites) |
| 8 | + - [Building (With or Without Packaging)](#building-with-or-without-packaging) |
| 9 | + - [Setting the binaries version output](#setting-the-binaries-version-output) |
| 10 | +- [Run the management](#run-the-management) |
| 11 | + - [Provide a config file](#provide-a-config-file) |
| 12 | + - [Provide TLS certificates](#provide-tls-certificates) |
| 13 | + - [Provide BeeMsg authentication file](#provide-beemsg-authentication-file) |
| 14 | + - [Set up the database](#set-up-the-database) |
| 15 | + - [Run the server](#run-the-server) |
6 | 16 |
|
7 |
| - ```shell |
8 |
| - git clone https://github.com/ThinkParQ/beegfs-rs |
9 |
| - cd beegfs-rs |
10 |
| - ``` |
| 17 | +The purpose of this repository is twofold: |
| 18 | + |
| 19 | +* Provide Rust packages for interacting with BeeGFS. |
| 20 | +* Provide BeeGFS-related software written in Rust, such as the BeeGFS management service. |
| 21 | + |
| 22 | +# Getting Started |
| 23 | + |
| 24 | +## Prerequisites |
11 | 25 |
|
12 |
| -3. The management can be built and run through cargo in one step: |
| 26 | +* If you just want to build/run the project without OS packages download and install Rust from |
| 27 | + [rustup](https://rustup.rs/). |
| 28 | +* If you want to build packages you also need to run `make install-tools`. |
| 29 | + * Note this only installs the tooling needed for a local, native build and is insufficient for |
| 30 | + cross-compilation. |
| 31 | + |
| 32 | +If you are interested in contributing to the project please refer to [Getting Started with Rust](https://github.com/ThinkParQ/beegfs-rust/wiki/Getting-Started-with-Rust) in the project wiki. |
| 33 | + |
| 34 | +## Building (With or Without Packaging) |
| 35 | + |
| 36 | +There are a few ways to build/run the BeeGFS management service: |
| 37 | + |
| 38 | +* The management can be built and run through cargo in one step: |
13 | 39 |
|
14 | 40 | ```shell
|
15 | 41 | cargo run -p mgmtd -- --help
|
|
24 | 50 | ./target/debug/mgmtd --help
|
25 | 51 | ```
|
26 | 52 |
|
27 |
| - Both ways are valid - down below, the first variant is used as it is quicker. |
| 53 | + Both ways are valid, in the below examples the first variant is used as it is quicker. |
| 54 | + |
| 55 | +* Build and install using OS packages: `make package` |
| 56 | + * Packages will be created under `target/package/` that can be installed using `dpkg -i <package>` |
| 57 | + or similar. |
28 | 58 |
|
29 | 59 | ## Setting the binaries version output
|
30 | 60 |
|
|
0 commit comments