Remove Host.ssh_host field (#413)

Having two separate fields for a label/hostname never made much sense.
In our database, we don't have any cases were the label and ssh_host
fields are set to different values. In most cases only ssh_host is set.

Remove the ssh_host field, only keep the label field for the hostname.

A data migration step copies the ssh_host value to the label field. As a
side benefit, this will ensure that all infrastructure hosts are
displayed with their hostname instead of ISD-AS,IP in the admin panel.

In the api/topology json, the host name is still called `ssh_host`.
We can rename this later, combined with other API breaking changes.

Author: matzf

scionlab/admin.py

@@ -197,7 +197,7 @@ def get_readonly_fields(self, request, obj):
 
 class HostAdminForm(_CreateUpdateModelForm):
     class Meta:
-        fields = ('AS', 'internal_ip', 'public_ip', 'bind_ip', 'label', 'ssh_host')
+        fields = ('AS', 'internal_ip', 'public_ip', 'bind_ip', 'label')
 
     secret = forms.CharField(required=False, widget=forms.TextInput(attrs={'size': '32'}))
 
@@ -208,7 +208,6 @@ def create(self):
             public_ip=self.cleaned_data['public_ip'],
             bind_ip=self.cleaned_data['bind_ip'],
             label=self.cleaned_data['label'],
-            ssh_host=self.cleaned_data['ssh_host'],
             secret=self.cleaned_data['secret']
         )
 
@@ -218,7 +217,6 @@ def update(self):
             public_ip=self.cleaned_data['public_ip'],
             bind_ip=self.cleaned_data['bind_ip'],
             label=self.cleaned_data['label'],
-            ssh_host=self.cleaned_data['ssh_host'],
             secret=self.cleaned_data['secret']
         )
 
@@ -749,10 +747,10 @@ class HostAdmin(HostAdminMixin, admin.ModelAdmin):
     form = HostAdminForm
     readonly_fields = ['uid', 'get_scionlab_config_cmd']
     list_display = ('__str__', 'AS',
-                    'internal_ip', 'public_ip', 'bind_ip', 'ssh_host',
+                    'internal_ip', 'public_ip', 'bind_ip',
                     'latest_config_deployed', 'get_scionlab_config_cmd', 'get_config_link')
     list_filter = ('AS__isd', 'AS', )
-    search_fields = ('AS__as_id', 'label', 'ssh_host')
+    search_fields = ('AS__as_id', 'label')
     ordering = ['AS']
 
     def get_urls(self):

scionlab/fixtures/testdata.yaml

@@ -3580,8 +3580,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.11
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.11
+    label: scionlab-1101-parapet
     uid: f470d0cceccc409c83393ac000e8d793
     secret: 2a3f2ee1b4a847d0b637872f2a7fa960
     config_version: 8
@@ -3594,8 +3593,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.12
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.12
+    label: scionlab-1102-dishwasher
     uid: f3ec4ddfecef4d9887509b660bd8805d
     secret: 15e18bd011f946caa12280280f0c330b
     config_version: 7
@@ -3608,8 +3606,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.13
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.13
+    label: scionlab-1103-waxier
     uid: daedabbf07aa4253ae55dc5f9e0ddab9
     secret: 19f3ea1f089343f082ab1a7a49c3caa4
     config_version: 7
@@ -3622,8 +3619,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.17
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.17
+    label: scionlab-1107-reals
     uid: b61daa99565446389397cbcd08d62f84
     secret: feef3b3f455e42c288803a1638b101f4
     config_version: 10
@@ -3636,8 +3632,7 @@
     internal_ip: 127.0.0.1
     public_ip: 172.31.0.110
     bind_ip: null
-    label: null
-    ssh_host: 172.31.0.110
+    label: scionlab-1301-cytoplasm
     uid: 747dc3fb869d466a81ea316f9a46ebb7
     secret: 0367e2079ff14e509bbe2d338b35164a
     config_version: 11
@@ -3650,8 +3645,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.32
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.32
+    label: scionlab-1302-paperhanger
     uid: 53922dccbb7144b987f2e4681e09f85b
     secret: 03fb466f164f4c99a7bb5b383099ba45
     config_version: 7
@@ -3664,8 +3658,7 @@
     internal_ip: 127.0.0.1
     public_ip: 172.31.0.111
     bind_ip: null
-    label: null
-    ssh_host: 172.31.0.111
+    label: scionlab-1303-premiere
     uid: b5150aeb217c42bb94f369fafbde9424
     secret: 7a66690be29048edb0960a4ca217d658
     config_version: 8
@@ -3678,8 +3671,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.34
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.34
+    label: scionlab-1304-beneficence
     uid: 2197a3cb85114c57a6598df981dd38b6
     secret: e13e26ce78d24442be170ccf23821cf8
     config_version: 7
@@ -3692,8 +3684,7 @@
     internal_ip: 127.0.0.1
     public_ip: 172.31.0.112
     bind_ip: null
-    label: null
-    ssh_host: 172.31.0.112
+    label: scionlab-1305-adulterers
     uid: 6c9a16b969e443e1a940943efcb42f38
     secret: 9315d60785f649bd81ceb24fb5a041d0
     config_version: 7
@@ -3706,8 +3697,7 @@
     internal_ip: 127.0.0.1
     public_ip: 172.31.0.113
     bind_ip: null
-    label: null
-    ssh_host: 172.31.0.113
+    label: scionlab-1401-orphaning
     uid: d158f36aa95c41ce9dca957496887da4
     secret: f0c384207d0f4890acb704921ec84528
     config_version: 9
@@ -3720,8 +3710,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.42
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.42
+    label: scionlab-1402-trawling
     uid: f40257382e764dbf901e7628e092ce9c
     secret: 3f3baf772ccb458db0e8384a9117d8d8
     config_version: 8
@@ -3734,8 +3723,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.43
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.43
+    label: scionlab-1403-inputting
     uid: ac36de474a9741528c81101176f41616
     secret: 92a9b0452ccc46b286b85bb262d1c5c6
     config_version: 8
@@ -3748,8 +3736,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.44
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.44
+    label: scionlab-1404-memorable
     uid: e5ced7199cce4bd68d449b7cc1308faf
     secret: 3e8963578bb747a4bd0cc361346458e9
     config_version: 9
@@ -3762,8 +3749,7 @@
     internal_ip: 127.0.0.1
     public_ip: 172.31.0.114
     bind_ip: null
-    label: null
-    ssh_host: 172.31.0.114
+    label: scionlab-1405-cauterise
     uid: c6d63a630ada49129549bacd10fee2a3
     secret: 5941ffa7a7c240b3aef1433d8e2b369f
     config_version: 9
@@ -3776,8 +3762,7 @@
     internal_ip: 127.0.0.1
     public_ip: 192.0.2.46
     bind_ip: null
-    label: null
-    ssh_host: 192.0.2.46
+    label: scionlab-1406-replenishes
     uid: cb92022181bd4e26ba3a280193a5f352
     secret: 1ee81564f8cf484d9310234e6cb1981e
     config_version: 7
@@ -3791,7 +3776,6 @@
     public_ip: null
     bind_ip: null
     label: null
-    ssh_host: null
     uid: 8882e778031c4df79fadcc272632aa6c
     secret: a2be4b0d3326420fbd4f7ae0d536166f
     config_version: 6
@@ -3805,7 +3789,6 @@
     public_ip: null
     bind_ip: null
     label: null
-    ssh_host: null
     uid: 4781698deccd4d318ee5e9d54642c9c0
     secret: 55c32d2364954c39a7c891366812a552
     config_version: 5
@@ -3819,7 +3802,6 @@
     public_ip: null
     bind_ip: null
     label: null
-    ssh_host: null
     uid: e31440806a4248469345b8c8e6e79580
     secret: e3bbb8648a0a4331b2d1d93807d44819
     config_version: 5
@@ -3833,7 +3815,6 @@
     public_ip: null
     bind_ip: null
     label: null
-    ssh_host: null
     uid: 3bc8312ec6984acf89db4c11f7e1dc6d
     secret: ec00adb395bf4d1d8b99ce40774be4d0
     config_version: 6
@@ -3847,7 +3828,6 @@
     public_ip: null
     bind_ip: null
     label: null
-    ssh_host: null
     uid: feda4b58f8a041209bb6acce636c9a9e
     secret: 9f932da7782a45dc991045baee592e01
     config_version: 5

scionlab/fixtures/testtopo.py

@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import pathlib
+import random
+import string
 from collections import namedtuple
 from scionlab.models.core import ISD, AS, Link, Host, Service
 from scionlab.models.user_as import AttachmentPoint
@@ -124,6 +127,7 @@ def create_testtopo():
     create_links()
     create_vpn()
     create_extraservices()
+    name_hosts()
 
 
 def create_isds():
@@ -156,6 +160,18 @@ def create_extraservices():
         Service.objects.create(host=host, type=as_serv[1])
 
 
+def name_hosts():
+    # assign random hostnames, loosely following the scionlab host naming convention
+    hosts = Host.objects.filter(AS__owner=None)
+    words = pathlib.Path('/usr/share/dict/words').read_text().split('\n')
+    words = [w for w in words if all(c in string.ascii_lowercase for c in w)]
+    names = random.sample(words, len(hosts))
+    for host, name in zip(hosts, names):
+        as_short_id = host.AS.as_id.split(':')[-1]
+        host.label = 'scionlab-%s-%s' % (as_short_id, name)
+        host.save()
+
+
 def _create_as(isd_id, as_id, label, public_ip, is_core=False, is_ap=False):
     isd = ISD.objects.get(isd_id=isd_id)
     as_ = AS.objects.create_with_default_services(
@@ -167,11 +183,6 @@ def _create_as(isd_id, as_id, label, public_ip, is_core=False, is_ap=False):
         init_certificates=False  # Defer certificates generation
     )
 
-    # This is also used in the integration tests for some ASes.
-    for host in as_.hosts.iterator():
-        host.ssh_host = host.public_ip
-        host.save()
-
     if is_ap:
         AttachmentPoint.objects.create(AS=as_)
 

scionlab/management/commands/export_zonefile.py

@@ -47,8 +47,8 @@ def handle(self, *args, **options):
 
         # Infrastructure
         # all hosts belonging to an AS without an owner
-        for infra in Host.objects.filter(AS__owner=None).exclude(ssh_host=None):
-            record_dict[infra.ssh_host] = infra.scion_address()
+        for infra in Host.objects.filter(AS__owner=None).exclude(label=None):
+            record_dict[infra.label] = infra.scion_address()
 
         # write zonefile
         zone_file = ':Z: %s %s [\n' % (options['zone'], options['context'])

scionlab/migrations/0007_remove_ssh_host.py

@@ -0,0 +1,29 @@
+# Generated by Django 3.2.5 on 2022-02-09 05:18
+
+from django.db import migrations, models
+
+
+def copy_ssh_host_to_label(apps, schema_editor):
+    Host = apps.get_model("scionlab", "Host")
+    Host.objects.filter(label=None).exclude(ssh_host=None).update(label=models.F('ssh_host'))
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('scionlab', '0006_bump_version_cs_hosts'),
+    ]
+
+    operations = [
+        migrations.RunPython(copy_ssh_host_to_label,  # forward
+                             lambda a, b: None),      # backward
+        migrations.RemoveField(
+            model_name='host',
+            name='ssh_host',
+        ),
+        migrations.AlterField(
+            model_name='host',
+            name='label',
+            field=models.CharField(blank=True, help_text='Hostname. For managed hosts, this should correspond to the hostname used in the ansible inventory.', max_length=255, null=True),
+        ),
+    ]

scionlab/models/core.py

@@ -491,13 +491,12 @@ class Host(models.Model):
         blank=True,
         help_text="Default bind IP for border router interfaces running on this host."
     )
-    label = models.CharField(max_length=_MAX_LEN_DEFAULT, null=True, blank=True)
-
-    ssh_host = models.CharField(
+    label = models.CharField(
         max_length=_MAX_LEN_DEFAULT,
         null=True,
         blank=True,
-        help_text="Hostname or IP for management access via SSH. Configured in run/ssh_config."
+        help_text="Hostname. For managed hosts, this should correspond to the hostname "
+                  "used in the ansible inventory."
     )
 
     uid = models.CharField(max_length=_MAX_LEN_DEFAULT, unique=True, editable=False,
@@ -537,7 +536,6 @@ def update(self,
                public_ip=_placeholder,
                bind_ip=_placeholder,
                label=_placeholder,
-               ssh_host=_placeholder,
                secret=_placeholder):
         """
         Update the specified fields of this host instance, and immediately `save`.
@@ -547,7 +545,6 @@ def update(self,
         :param str public_ip: optional, default public IP for border router interfaces on this host
         :param str bind_ip: optional, default bind IP for border router interfaces on this host
         :param str label: optional
-        :param str ssh_host: optional, hostname/IP for management access via SSH
         :param str secret: optional, a secret to authenticate the host. If `None` is given, a new
                            random secret is generated.
         """
@@ -565,8 +562,6 @@ def update(self,
             self.bind_ip = bind_ip or None
         if label is not _placeholder:
             self.label = label or None
-        if ssh_host is not _placeholder:
-            self.ssh_host = ssh_host or None
         if secret is not _placeholder:
             self.secret = secret or uuid.uuid4().hex
 

scionlab/views/topology.py

@@ -135,7 +135,7 @@ def json_service(s):
         return {
             'type': service_type,
             'metrics_port': s.metrics_port,
-            'ssh_host': s.host.ssh_host,
+            'ssh_host': s.host.label,  # TODO(matzf) rename this field to host or hostname
         }
 
     def json_as(as_):

scripts/import_topo.py

@@ -94,7 +94,7 @@ def create_as(ia, data):
 def create_hosts(as_, hosts):
     for name, data in hosts.items():
         as_short_id = as_.as_id.split(':')[-1]
-        ssh_host = 'scionlab-%s-%s' % (as_short_id, name)
+        hostname = 'scionlab-%s-%s' % (as_short_id, name)
 
         internal_ip = data['address']
         public_ip = data.get('public', None)
@@ -103,7 +103,7 @@ def create_hosts(as_, hosts):
             public_ip=public_ip,
             bind_ip=None,
             internal_ip=internal_ip,
-            ssh_host=ssh_host,
+            label=hostname,
         )
 
     service_host = as_.hosts.first()
@@ -114,8 +114,8 @@ def create_links(links):
     for link, data in links.items():
         a, b = link.split('--')
         try:
-            host_a = Host.objects.filter(ssh_host__endswith=a).get()
-            host_b = Host.objects.filter(ssh_host__endswith=b).get()
+            host_a = Host.objects.filter(label__endswith=a).get()
+            host_b = Host.objects.filter(label__endswith=b).get()
         except Host.DoesNotExist as e:
             print("Skipping link", a, b, ":", e)
             continue