Skip to content

Commit

Permalink
chore(renaming): use consistent naming
Browse files Browse the repository at this point in the history
Ensure consistent naming convention is used.

Rename "mayastor-dependencies" to "io-engine-dependencies".
Rename the mayastor directory to io-engine.
Rename mayastor-client to io-engine-client
  • Loading branch information
Paul Yoong committed May 27, 2022
1 parent cd4bcdb commit 7b0b0eb
Show file tree
Hide file tree
Showing 205 changed files with 284 additions and 285 deletions.
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
[submodule "spdk-rs"]
path = spdk-rs
url = https://github.com/mayadata-io/spdk-rs
[submodule "utils/mayastor-dependencies"]
path = utils/mayastor-dependencies
[submodule "utils/io-engine-dependencies"]
path = utils/io-engine-dependencies
url = https://github.com/openebs/mayastor-dependencies.git
142 changes: 71 additions & 71 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ panic = "abort"
members = [
"jsonrpc",
"libnvme-rs",
"mayastor",
"io-engine",
"rpc",
"sysfs",
"composer",
"spdk-rs",
"utils/mayastor-dependencies/version-info",
"utils/io-engine-dependencies/version-info",
]
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ At a high-level, Mayastor consists of two major components.

### **Control plane:**

* A microservices patterned control plane, centered around a core agent which publically exposes a RESTful API. This is extended by a dedicated operator responsible
* A microservices patterned control plane, centered around a core agent which publicly exposes a RESTful API. This is extended by a dedicated operator responsible
for managing the life cycle of "Mayastor Pools" (an abstraction for devices supplying the cluster with persistent backing storage) and a CSI compliant external provisioner (controller).
Source code for the control plane components is located in its [own repository](https://github.com/openebs/mayastor-control-plane)

Expand Down Expand Up @@ -82,8 +82,8 @@ You can also directly use the nexus from within your application code. For examp
</p>

```rust
use mayastor::descriptor::{Descriptor, DmaBuf};
use mayastor::bdev::nexus::nexus_bdev::nexus_create;
use io_engine::descriptor::{Descriptor, DmaBuf};
use io_engine::bdev::nexus::nexus_bdev::nexus_create;

let children = vec![
"aio:////disk1.img?blk_size=512".to_string(),
Expand Down Expand Up @@ -180,21 +180,21 @@ $ dd if=/dev/zero of=/tmp/disk bs=1024 count=102400
102400+0 records out
104857600 bytes (105 MB, 100 MiB) copied, 0.235195 s, 446 MB/s
$ sudo losetup /dev/loop8 /tmp/disk
$ mayastor-client pool create tpool /dev/loop8
$ mayastor-client pool list
$ io-engine-client pool create tpool /dev/loop8
$ io-engine-client pool list
NAME STATE CAPACITY USED DISKS
tpool 0 96.0 MiB 0 B tpool
$ mayastor-client replica create tpool replica1 --size=10
$ mayastor-client replica create tpool replica2 --size=1000 --thin
$ mayastor-client replica list
$ io-engine-client replica create tpool replica1 --size=10
$ io-engine-client replica create tpool replica2 --size=1000 --thin
$ io-engine-client replica list
POOL NAME THIN SIZE
tpool replica1 false 10.0 MiB
tpool replica2 true 1.0 GiB
$ mayastor-client replica destroy tpool replica1
$ mayastor-client replica destroy tpool replica2
$ mayastor-client replica list
$ io-engine-client replica destroy tpool replica1
$ io-engine-client replica destroy tpool replica2
$ io-engine-client replica list
No replicas have been created
$ mayastor-client pool destroy tpool
$ io-engine-client pool destroy tpool
```

## Links
Expand Down
10 changes: 5 additions & 5 deletions ci.nix
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ let
sources = import ./nix/sources.nix;
pkgs = import sources.nixpkgs {
overlays =
[ (_: _: { inherit sources; }) (import ./nix/mayastor-overlay.nix) ];
[ (_: _: { inherit sources; }) (import ./nix/io-engine-overlay.nix) ];
};
in
with pkgs;
Expand All @@ -18,7 +18,7 @@ let
(ps: with ps; [ virtualenv grpcio grpcio-tools asyncssh black ]);
in
mkShell {
name = "mayastor-dev-shell";
name = "io-engine-dev-shell";
# fortify does not work with -O0 which is used by spdk when --enable-debug
hardeningDisable = [ "fortify" ];
buildInputs = [
Expand Down Expand Up @@ -57,9 +57,9 @@ mkShell {
++ pkgs.lib.optional (!norust) channel.nightly;

RUST_NIGHTLY_PATH = channel.nightly;
LIBCLANG_PATH = mayastor.LIBCLANG_PATH;
PROTOC = mayastor.PROTOC;
PROTOC_INCLUDE = mayastor.PROTOC_INCLUDE;
LIBCLANG_PATH = io-engine.LIBCLANG_PATH;
PROTOC = io-engine.PROTOC;
PROTOC_INCLUDE = io-engine.PROTOC_INCLUDE;
SPDK_PATH = if nospdk then null else "${libspdk-dev}";

shellHook = ''
Expand Down
8 changes: 4 additions & 4 deletions composer/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ impl Builder {
pub fn add_container(mut self, name: &str) -> Builder {
self.containers.push(ContainerSpec::from_binary(
name,
Binary::from_dbg("mayastor"),
Binary::from_dbg("io-engine"),
));
self
}
Expand Down Expand Up @@ -1306,14 +1306,14 @@ mod tests {
let test = Builder::new()
.name("composer")
.network("10.1.0.0/16")
.add_container("mayastor")
.add_container_bin("mayastor2", Binary::from_dbg("mayastor"))
.add_container("io-engine")
.add_container_bin("mayastor2", Binary::from_dbg("io-engine"))
.with_clean(true)
.build()
.await
.unwrap();

let mut hdl = test.grpc_handle("mayastor").await.unwrap();
let mut hdl = test.grpc_handle("io-engine").await.unwrap();
hdl.mayastor.list_nexus(Null {}).await.expect("list nexus");

// run with --nocapture to get the logs
Expand Down
5 changes: 2 additions & 3 deletions default.nix
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
{
crossSystem ? null
{ crossSystem ? null
}:

let
sources = import ./nix/sources.nix;
pkgs = import sources.nixpkgs {
overlays = [
(_: _: { inherit sources; })
(import ./nix/mayastor-overlay.nix)
(import ./nix/io-engine-overlay.nix)
];
inherit crossSystem;
};
Expand Down
4 changes: 2 additions & 2 deletions doc/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ nix shell -f . mayastor
In order to make an artifact which can be distributed, we use [`nix bundle`][nix-bundle].
> **TODO:** We currently don't generate bundles some executables, such as
> `mayastor-client`. This is coming.
> `io-engine-client`. This is coming.
```bash
for BUNDLE in mayastor; do
Expand All @@ -182,7 +182,7 @@ Build the Docker images with [`nix build`][nix-build]:
```bash
for IMAGE in \
mayastor-client mayastor mayastor-csi mayastor-client kiiss-service \
io-engine-client mayastor mayastor-csi io-engine-client kiiss-service \
node-service volume-service pool-service rest-service node-operator; \
do
echo "Building ${IMAGE} to artifacts/docker/${IMAGE}.tar"; \
Expand Down
Loading

0 comments on commit 7b0b0eb

Please sign in to comment.