Merge #680

680: refactor(ctrl-plane): tidy up the control-plane r=tiagolobocastro a=tiagolobocastro

Reorganize the control-plane components in the repo by moving them to a
 separate control-plane directory.
Rename the services into agents.

Build the control plane components as a separate derivation with a lot
 less dependencies which reduces the build type.
Create unique derivation for each control plane component.
Make use of these components on the container image which reduces the
 image size.

Co-authored-by: Tiago Castro <tiago.castro@mayadata.io>

Author: mayastor-bors

Cargo.lock

@@ -14,10 +14,11 @@ members = [
 	"nvmeadm",
 	"rpc",
 	"sysfs",
-	"services",
-	"mbus-api",
+	"control-plane/agents",
+	"control-plane/mbus-api",
 	"composer",
-	"rest",
-	"operators",
-	"mayastor-macros"
+	"control-plane/rest",
+	"control-plane/operators",
+	"control-plane/macros",
+	"control-plane/deployer"
 ]

Cargo.toml

@@ -16,7 +16,7 @@ ipnetwork = "0.17.0"
 bollard = "0.8.0"
 tracing = "0.1.22"
 tracing-subscriber = "0.2.15"
-mbus_api = { path = "../mbus-api" }
+mbus_api = { path = "../control-plane/mbus-api" }
 
 [dev-dependencies]
 tokio = { version = "0.2", features = ["full"] }

composer/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "services"
+name = "agents"
 version = "0.1.0"
 authors = ["Tiago Castro <tiago.castro@mayadata.io>"]
 edition = "2018"
@@ -20,10 +20,6 @@ path = "pool/src/server.rs"
 name = "volume"
 path = "volume/src/server.rs"
 
-[[bin]]
-name = "deployer"
-path = "deployer/src/bin.rs"
-
 [[bin]]
 name = "jsongrpc"
 path = "jsongrpc/src/server.rs"
@@ -35,7 +31,6 @@ path = "common/src/lib.rs"
 
 [dependencies]
 mbus_api = { path = "../mbus-api" }
-composer = { path = "../composer" }
 nats = "0.8"
 structopt = "0.3.15"
 tokio = { version = "0.2", features = ["full"] }
@@ -52,12 +47,12 @@ state = "0.4.2"
 tracing = "0.1"
 tracing-subscriber = "0.2"
 tracing-futures = "0.2.4"
-rpc = { path = "../rpc" }
+rpc = { path = "../../rpc" }
 url = "2.2.0"
 http = "0.2.1"
-strum = "0.19"
-strum_macros = "0.19"
-paste = "1.0.4"
+
+[dev-dependencies]
+composer = { path = "../../composer" }
 
 [dependencies.serde]
 features = ["derive"]

services/Cargo.toml control-plane/agents/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "deployer"
+version = "0.1.0"
+authors = ["Tiago Castro <tiago.castro@mayadata.io>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[[bin]]
+name = "deployer"
+path = "src/bin.rs"
+
+[dependencies]
+mbus_api = { path = "../mbus-api" }
+composer = { path = "../../composer" }
+nats = "0.8"
+structopt = "0.3.15"
+tokio = { version = "0.2", features = ["full"] }
+async-trait = "0.1.36"
+rpc = { path = "../../rpc" }
+strum = "0.19"
+strum_macros = "0.19"
+paste = "1.0.4"

services/common/src/lib.rs control-plane/agents/common/src/lib.rs

@@ -1,19 +1,19 @@
 # Control Plane Deployer
 
-Deploying all the `control plane services` with all the trimmings is not an entirely straightforward exercise as there
+Deploying all the `control plane agents` with all the trimmings is not an entirely straightforward exercise as there
 are many parts to it, including the additional configuration steps to be able to run multiple `mayastor` instances
 alongside each other.
 
 The `deployer` tool facilitates this by creating a composable docker `"cluster"` which allows us to run any number of
-`mayastor` instances, the `control plane services` and any other pluggable components.
+`mayastor` instances, the `control plane agents` and any other pluggable components.
 
 ## Examples
 
 **Using the help**
 ```textmate
 [nix-shell:~/git/Mayastor]$ cargo run --bin deployer -- --help
   deployer --help
-  services 0.1.0
+  agents 0.1.0
   Deployment actions
 
   USAGE:
@@ -37,15 +37,15 @@ The help can also be used on each subcommand.
 [nix-shell:~/git/Mayastor]$ cargo run --bin deployer -- start -m 2
     Finished dev [unoptimized + debuginfo] target(s) in 0.13s
      Running `sh /home/tiago/git/myconfigs/maya/test_as_sudo.sh target/debug/deployer start`
-Using options: CliArgs { action: Start(StartOptions { services: [Node(Node), Pool(Pool), Volume(Volume)], base_image: None, jaeger: false, no_rest: false, mayastors: 2, jaeger_image: None, build: false, dns: false, show_info: false, cluster_name: "cluster" }) }
+Using options: CliArgs { action: Start(StartOptions { agents: [Node(Node), Pool(Pool), Volume(Volume)], base_image: None, jaeger: false, no_rest: false, mayastors: 2, jaeger_image: None, build: false, dns: false, show_info: false, cluster_name: "cluster" }) }
 ```
 
 Notice the options which are printed out. They can be overridden - more on this later.
 
 We could also use the `deploy` tool to inspect the components:
 ```textmate
 [nix-shell:~/git/Mayastor]$ cargo run --bin deployer -- list
-   Compiling services v0.1.0 (/home/tiago/git/Mayastor/services)
+   Compiling agents v0.1.0 (/home/tiago/git/Mayastor/agents)
     Finished dev [unoptimized + debuginfo] target(s) in 5.50s
      Running `sh /home/tiago/git/myconfigs/maya/test_as_sudo.sh target/debug/deployer list`
 Using options: CliArgs { action: List(ListOptions { no_docker: false, format: None }) }
@@ -92,10 +92,10 @@ For more information, please refer to the help argument on every command/subcomm
 For example, to debug the rest server, we'd create a `cluster` without the rest server:
 ```textmate
 [nix-shell:~/git/Mayastor]$ cargo run --bin deployer -- start --no-rest --show-info
-   Compiling services v0.1.0 (/home/tiago/git/Mayastor/services)
+   Compiling agents v0.1.0 (/home/tiago/git/Mayastor/agents)
     Finished dev [unoptimized + debuginfo] target(s) in 5.86s
      Running `sh /home/tiago/git/myconfigs/maya/test_as_sudo.sh target/debug/deployer start --no-rest --show-info`
-Using options: CliArgs { action: Start(StartOptions { services: [Node(Node), Pool(Pool), Volume(Volume)], base_image: None, jaeger: false, no_rest: true, mayastors: 1, jaeger_image: None, build: false, dns: false, show_info: true, cluster_name: "cluster" }) }
+Using options: CliArgs { action: Start(StartOptions { agents: [Node(Node), Pool(Pool), Volume(Volume)], base_image: None, jaeger: false, no_rest: true, mayastors: 1, jaeger_image: None, build: false, dns: false, show_info: true, cluster_name: "cluster" }) }
 [20994b0098d6] [/volume] /home/tiago/git/Mayastor/target/debug/volume -n nats.cluster:4222
 [f4884e343756] [/pool] /home/tiago/git/Mayastor/target/debug/pool -n nats.cluster:4222
 [fb6e78a0b6ef] [/node] /home/tiago/git/Mayastor/target/debug/node -n nats.cluster:4222

services/common/src/wrapper/mod.rs control-plane/agents/common/src/wrapper/mod.rs

@@ -47,20 +47,20 @@ pub(crate) struct ListOptions {
 #[derive(Debug, Clone, StructOpt)]
 #[structopt(about = "Create and start all components")]
 pub(crate) struct StartOptions {
-    /// Use the following Control Plane Services
-    /// Specify one service at a time or as a list.
-    /// ( "" for no services )
+    /// Use the following Control Plane Agents
+    /// Specify one agent at a time or as a list.
+    /// ( "" for no agents )
     /// todo: specify start arguments, eg: Node="-v"
     #[structopt(
         short,
         long,
         default_value = "Node, Pool, Volume",
         value_delimiter = ","
     )]
-    services: Vec<ControlPlaneService>,
+    agents: Vec<ControlPlaneAgent>,
 
     /// Use the following Control Plane Operators
-    /// Specify one service at a time or as a list
+    /// Specify one operator at a time or as a list
     #[structopt(short, long, value_delimiter = ",")]
     operators: Option<Vec<ControlPlaneOperator>>,
 
@@ -99,7 +99,7 @@ pub(crate) struct StartOptions {
     dns: bool,
 
     /// Show information from the cluster after creation
-    #[structopt(long)]
+    #[structopt(short, long)]
     show_info: bool,
 
     /// Name of the cluster - currently only one allowed at a time