Skip to content

Commit 4b7baff

Browse files
committed
doc/reference/applications/: Add listings for debug, incus-ceph, and incus-linstor applications
Signed-off-by: Mathias Gibbens <mathias.gibbens@futurfusion.io>
1 parent 6e30a88 commit 4b7baff

6 files changed

Lines changed: 38 additions & 5 deletions

File tree

doc/reference/applications.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ The primary application is responsible for listening on the network and
77
for handling user authentication. It then provides access to the IncusOS
88
management API through its own API.
99

10-
IncusOS also supports additional (non-primary) applications which can
11-
extend the base system (for example for debugging) or provide additional
12-
features to another application.
10+
IncusOS also supports [additional](applications/non-primary.md) (non-primary)
11+
applications which can extend the base system (for example for debugging) or
12+
provide additional features to another application.
1313

1414
```{toctree}
1515
:maxdepth: 1
@@ -19,4 +19,6 @@ Migration Manager </reference/applications/migration-manager>
1919
Operations Center </reference/applications/operations-center>
2020
2121
Shared API </reference/applications/shared-api>
22+
23+
Non-primary applications </reference/applications/non-primary>
2224
```
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Debug
2+
3+
The Debug application provides several additional tools that can be useful for developers working on debugging issues in an IncusOS system:
4+
5+
* `htop`
6+
* `ifstat`
7+
* `iputils-ping`
8+
* `nano`
9+
* `mtr-tiny`
10+
* `net-tools`
11+
* `netcat-openbsd`
12+
* `procps`
13+
* `strace`
14+
* `tcpdump`
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Incus Ceph
2+
3+
The Incus Ceph (`incus-ceph`) application installs the Ceph client for Incus deployments needing to use [Ceph storage](../services/ceph.md).
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Incus Linstor
2+
3+
The Incus Linstor (`incus-linstor`) application installs Linstor satellite support for Incus deployments needing to use [Linstor storage](../services/linstor.md).

doc/reference/applications/incus.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ Important seed fields include:
2828

2929
Two additional applications exist which extend the main Incus application:
3030

31-
* `incus-ceph`: Adds Ceph client support
32-
* `incus-linstor`: Add Linstor satellite support
31+
* `incus-ceph`: Adds [Ceph](../services/ceph.md) client support
32+
* `incus-linstor`: Adds [Linstor](../services/linstor.md) satellite support
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Non-primary applications
2+
3+
IncusOS uses non-primary applications to enhance the functionality of a primary application or provide debugging support.
4+
5+
```{toctree}
6+
:maxdepth: 1
7+
8+
Debug </reference/applications/debug>
9+
Incus-Ceph </reference/applications/incus-ceph>
10+
Incus-Linstor </reference/applications/incus-linstor>
11+
```

0 commit comments

Comments
 (0)