Merge pull request #59 from serverscom/rbs-docs

adding rbs and feature-set docs

Author: anvyst

docs/srvctl-hosts-ebm-feature-set/description.md

@@ -0,0 +1,14 @@
+This command activates or deactivates a feature on the selected enterprise bare metal server.
+
+The `--feature` and `--state` flags are required. The `--state` flag accepts `activate` or `deactivate`.
+
+Supported feature names:
+
+- `disaggregated_public_ports` - disaggregated public network ports.
+- `disaggregated_private_ports` - disaggregated private network ports.
+- `no_public_ip_address` - disable public IP address assignment.
+- `no_private_ip` - disable private IP address assignment.
+- `oob_public_access` - enable public access to out-of-band management.
+- `no_public_network` - disable public network connectivity.
+- `host_rescue_mode` - boot into rescue mode. When activating, use `--auth-method` (repeatable: `password`, `ssh_key`) and `--ssh-key-fingerprint` (repeatable) to configure access.
+- `private_ipxe_boot` - boot from a private iPXE script. When activating, use `--ipxe-config` to supply the iPXE script.

docs/srvctl-hosts-ebm-feature-set/examples.md

@@ -0,0 +1,37 @@
+A command to activate disaggregated public ports on the server with the "ex4mp1eID" ID:
+
+```
+srvctl hosts ebm feature-set ex4mp1eID --feature disaggregated_public_ports --state activate
+```
+
+A command to deactivate disaggregated public ports on the server with the "ex4mp1eID" ID:
+
+```
+srvctl hosts ebm feature-set ex4mp1eID --feature disaggregated_public_ports --state deactivate
+```
+
+A command to activate rescue mode with password and SSH key authentication:
+
+```
+srvctl hosts ebm feature-set ex4mp1eID \
+	--feature host_rescue_mode \
+	--state activate \
+	--auth-method password \
+	--auth-method ssh_key \
+	--ssh-key-fingerprint aa:bb:cc:dd:ee:ff
+```
+
+A command to activate private iPXE boot with a custom script:
+
+```
+srvctl hosts ebm feature-set ex4mp1eID \
+	--feature private_ipxe_boot \
+	--state activate \
+	--ipxe-config "#!ipxe\nchain http://boot.example.com/script.ipxe"
+```
+
+A command to deactivate rescue mode:
+
+```
+srvctl hosts ebm feature-set ex4mp1eID --feature host_rescue_mode --state deactivate
+```

docs/srvctl-rbs-add/description.md

@@ -0,0 +1,5 @@
+A command to create a new remote block storage volume. It allows to pass parameters in two ways:
+
+- Input - volume parameters are described in a file, a path to the file is specified via the `-i` or `--input` flag. The path can be absolute or relative to the srvctl file. There is also an option to use standard input (stdin) when specifying the flag this way: `--input -`
+
+- Flags - parameters are specified via flags inside the command. The `--name`, `--size`, and `--flavor-id` flags are required.

docs/srvctl-rbs-add/examples.md

@@ -0,0 +1,30 @@
+An example of a command for a file in the same directory with srvctl:
+
+```
+srvctl rbs add --input <file name>
+```
+
+An example of the file's content:
+
+```
+{
+    "name": "",
+    "size": 0,
+    "location_id": 0,
+    "flavor_id": 0,
+    "labels": {
+        "key": "value"
+    }
+}
+```
+
+An example of a command to create a remote block storage volume via flags:
+
+```
+srvctl rbs add \
+	--name my-volume \
+	--size 100 \
+	--flavor-id 1 \
+	--location-id 1 \
+	--label environment=production
+```

docs/srvctl-rbs-delete/description.md

@@ -0,0 +1 @@
+This command deletes the selected remote block storage volume.

docs/srvctl-rbs-delete/examples.md

@@ -0,0 +1,5 @@
+A command to delete the remote block storage volume with the "ex4mp1eID" ID:
+
+```
+srvctl rbs delete ex4mp1eID
+```

docs/srvctl-rbs-get-credentials/description.md

@@ -0,0 +1 @@
+This command provides iSCSI credentials for the selected remote block storage volume, including username, password, target IQN, and IP address.

docs/srvctl-rbs-get-credentials/examples.md

@@ -0,0 +1,5 @@
+A command to get credentials for the remote block storage volume with the "ex4mp1eID" ID:
+
+```
+srvctl rbs get-credentials ex4mp1eID
+```

docs/srvctl-rbs-get/description.md

@@ -0,0 +1 @@
+This command provides information for the selected remote block storage volume.

docs/srvctl-rbs-get/examples.md

@@ -0,0 +1,5 @@
+A command to get information for the remote block storage volume with the "ex4mp1eID" ID:
+
+```
+srvctl rbs get ex4mp1eID
+```