Move introduction from index into subchapters

Nitrokey · Oct 14, 2024 · 90b517d · 90b517d
1 parent 0e7582a
commit 90b517d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 13 deletions.
diff --git a/nethsm/container/container-hardware-restriction.rst.inc b/nethsm/container/container-hardware-restriction.rst.inc
@@ -0,0 +1,6 @@
+Compared to the NetHSM hardware the following functions are not implemented at software container's REST API:
+
+* Network configuration
+* Factory reset
+* Reboot
+* Software update
diff --git a/nethsm/container/index.rst b/nethsm/container/index.rst
@@ -1,20 +1,9 @@
 Container
 =========
 
-Software container images of NetHSM are available for testing and production.
-They are distributed as OCI images and can be run locally with a compatible executor such as Docker and Podman.
-
-Compared to the NetHSM hardware the following functions are not implemented at software container's REST API:
-
-* Network configuration
-* Factory reset
-* Reboot
-* Software update
-
-Refer to the following chapters to learn more about the respective differences.
+Please refer to the following chapters to learn more about the NetHSM container images.
 
 .. toctree::
-   :hidden:
    :maxdepth: 1
    :glob:
 

diff --git a/nethsm/container/production-image.rst b/nethsm/container/production-image.rst
@@ -1,11 +1,14 @@
 Production Image
 ----------------
 
-The production image is provided for production envrionments with high security demands.
+The production image is provided for production environments with high security demands.
+The image is distributed as OCI image and can be run locally with a compatible executor such as Docker and Podman.
 It requires an external etcd key-value store and offers to run the NetHSM process with hardware-based separation (KVM).
 The connection between the NetHSM process and the key-value store is encrypted.
 Additionally, the required secrets such as certificates and private keys can be set through the secrets feature of the container executor.
 
+.. include:: container-hardware-restriction.rst.inc
+
 The NetHSM production container is a product for paying customers only and can be purchased `here <https://www.nitrokey.com/contact>`__.
 The image can be obtained from `Nitrokey NetHSM registry <https://registry.git.nitrokey.com/distribution/nethsm>`_ using the credentials provided after purchase.
 

diff --git a/nethsm/container/test-image.rst b/nethsm/container/test-image.rst
@@ -2,9 +2,12 @@ Test Image
 ----------
 
 The test image is provided for testing and development purposes.
+The image is distributed as OCI image and can be run locally with a compatible executor such as Docker and Podman.
 It does not offer to run the NetHSM process with hardware-based separation (KVM).
 The connection between the NetHSM process and the integrated key-value store is unencrypted.
 
+.. include:: container-hardware-restriction.rst.inc
+
 The image can be obtained from `Docker Hub <https://hub.docker.com/r/nitrokey/nethsm>`_.
 
 .. warning::