Add port, keys, user to DatabaseInfo with parent field ssh_info (#353)

Co-authored-by: Torsten Kilias <[email protected]>

doc/changes/changes_2.0.0.md

@@ -4,13 +4,19 @@
 
 Version 2.0.0 of ITDE comes with breaking changes as public API class `DatabaseInfo` has been changed.  Former separate attributes `database_port_forward`and `bucketfs_port_forward` have been replaced by a single attribute `port` set to an instance of `PortForwarding` with attributes `database`, `bucketfs`, and `ssh`.
 
+Previous versions of the ITDE used `docker_exec` to access the Docker Container, e.g. to analyze the content of logfiles or execute some shell commands. In future versions of the Exasol Docker-DB the format of the Docker Containers might change so that `docker_exec` is no longer possible. Instead ITDE will then need to use SSH access.
+
+The current release therefore enhances ITDE to enable to access the Docker Container via SSH.  The user can select the docker access method with command line option `--db-os-access` and can specify a port number to which ITDE forwards the SSH port of the Docker Container, see User Guide.
+
+Additionally the directory for storing the randomly generated SSH keys has been moved to `~/.cache/exasol/itde/`. By that ITDE can restrict file permissions allowing access only by the current user.
+
 T.B.D.
 
 ### Supported Exasol Versions
 
 * **7.0**: up to 7.0.20, **except 7.0.5**
 * **7.1**: up to 7.1.17
-* **8.17.0** and 8.18.1
+* **8**: 8.18.1
 
 If you need further versions, please open an issue.
 
@@ -19,3 +25,4 @@ If you need further versions, please open an issue.
 ## Changes
 
 * #329: Added CLI option `--ssh-port-forward` to forward SSH port
+* #343: Added SshInfo to DatabaseInfo containing user, port and path to SSH key file

docker_db_config_template/7.0.0/EXAConf

@@ -61,15 +61,15 @@
         Group = root
         LoginEnabled = True
         AdditionalGroups = exausers, exadbadm, exastoradm, exabfsadm, exaadm
-        AuthorizedKeys = {{authorized_keys}}
+        AuthorizedKeys = {{ authorized_keys }}
     [[exadefusr]]
         ID = 500
         Group = exausers
         LoginEnabled = False
         AdditionalGroups = exadbadm, exastoradm, exabfsadm, exaadm
 
 [Node : 11]
-    PrivateNet = {{private_network}}
+    PrivateNet = {{ private_network }}
     PublicNet =
     Name = n11
     UUID = A5F8F92113A34BA4B0A48D5397423BBA5CF95161
@@ -118,7 +118,7 @@
 # An EXASOL database
 [DB : DB1]
     # Version nr. of this database.
-    Version = {{db_version}}
+    Version = {{ db_version }}
     # Memory size over all nodes (e. g. '1 TiB').
     MemSize = {{ mem_size }}
     Port = 8888

docker_db_config_template/7.1.0/EXAConf

@@ -81,7 +81,7 @@
         AdditionalGroups = exadbadm, exastoradm, exabfsadm, exaadm
 
 [Node : 11]
-    PrivateNet = {{private_network}}
+    PrivateNet = {{ private_network }}
     PublicNet =
     Name = n11
     # Affinity decides how this node is used in the cluster. i.e, the possibility to become master
@@ -132,7 +132,7 @@
 # An EXASOL database
 [DB : DB1]
     # Version nr. of this database.
-    Version = {{db_version}}
+    Version = {{ db_version }}
     # Memory size over all nodes (e. g. '1 TiB').
     MemSize = {{ mem_size }}
     Port = 8888

docker_db_config_template/8.17.0/EXAConf

@@ -84,7 +84,7 @@
         Group = root
         LoginEnabled = True
         AdditionalGroups = exausers, exaadm, exadbadm, exastoradm, exabfsadm, exasaasadm
-        AuthorizedKeys = {{authorized_keys}}
+        AuthorizedKeys = {{ authorized_keys }}
     [[exadefusr]]
         ID = 500
         Group = exausers
@@ -97,7 +97,7 @@
         AdditionalGroups = exasaasadm,
 
 [Node : 11]
-    PrivateNet = {{private_network}}
+    PrivateNet = {{ private_network }}
     PublicNet =
     Name = n11
     # Affinity decides how this node is used in the cluster. i.e, the possibility to become master
@@ -156,7 +156,7 @@
     # Unique id of this database.
     ID = aCbUZhU3R8eEc0UIDS7wQw
     # Version nr. of this database.
-    Version = {{db_version}}
+    Version = {{ db_version }}
     # Memory size over all nodes (e. g. '1 TiB').
     MemSize = {{ mem_size }}
     Port = 8888

docker_db_config_template/8.18.1/EXAConf

@@ -97,7 +97,7 @@
         AdditionalGroups = exasaasadm,
 
 [Node : 11]
-    PrivateNet = {{private_network}}
+    PrivateNet = {{ private_network }}
     PublicNet =
     Name = n11
     # Affinity decides how this node is used in the cluster. i.e, the possibility to become master
@@ -156,7 +156,7 @@
     # Unique id of this database.
     ID = aCbUZhU3R8eEc0UIDS7wQw
     # Version nr. of this database.
-    Version = {{db_version}}
+    Version = {{ db_version }}
     # Memory size over all nodes (e. g. '1 TiB').
     MemSize = {{ mem_size }}
     Port = 8888