Add aggregate filtering and isolation options

Add limit-tenants-to-placement-aggregate,
placement-aggregate-required-for-tenants and
enable-isolated-aggregate-filtering options.

Resolved Conflicts:
	config.yaml

Closes-Bug: #1920982
Change-Id: Ibbb0e412d1a821cdb56e447ca88b91afca50c8c6
(cherry picked from commit 6c1efee2d0)

config.yaml

@@ -699,3 +699,82 @@ options:
       this option sets True as the default value, which is consistent with the
       default value 'WSGISocketRotation On' in Apache. This option should be
       used with caution. Please read the Apache doc page for more information.
+  limit-tenants-to-placement-aggregate:
+    type: boolean
+    default: False
+    description: |
+      This setting causes the scheduler to look up a host aggregate with the
+      metadata key of filter_tenant_id set to the project of an incoming
+      request, and request results from placement be limited to that
+      aggregate. Multiple tenants may be added to a single aggregate by
+      appending a serial number to the key, such as filter_tenant_id:123.
+      .
+      The matching aggregate UUID must be mirrored in placement for proper
+      operation. If no host aggregate with the tenant id is found, or that
+      aggregate does not match one in placement, the result will be the same
+      as not finding any suitable hosts for the request.
+      .
+      Set this option to True if you require instances for a particular tenant
+      to be placed in a particular host aggregate (i.e. a particular host or
+      set of hosts). After enabling this option, follow
+      https://docs.openstack.org/nova/latest/admin/aggregates.html#tenant-isolation-with-placement
+      for details on creating and configuring host aggregates and resource
+      providers.
+      .
+      Note that this will not prevent other tenants, who aren't associated with
+      a host aggregate, from launching instances on hosts within this
+      aggregate.
+      .
+      Also see the placement-aggregate-required-for-tenants and
+      enable-isolated-aggregate-filtering options.
+      .
+      This is only supported on OpenStack Train or later releases.
+  placement-aggregate-required-for-tenants:
+    type: boolean
+    default: False
+    description: |
+      This setting, which only has an effect when
+      limit-tenants-to-placement-aggregate is set to True, will control whether
+      or not a tenant with no aggregate affinity will be allowed to schedule to
+      any available node. If aggregates are used to limit some tenants but not
+      all, then this should be False. If all tenants should be confined via
+      aggregate, then this should be True to prevent them from receiving
+      unrestricted scheduling to any available node.
+      .
+      Set this option to True under the rare circumstance where you want to
+      manually control instance placement by associating every tenant with
+      a host aggregate. If you set this option to True and have tenants that
+      are not associated with a host aggregate, those tenants will no longer be
+      able to launch instances.
+      .
+      Also see the limit-tenants-to-placement-aggregate and
+      enable-isolated-aggregate-filtering options.
+      .
+      This is only supported on OpenStack Train or later releases.
+  enable-isolated-aggregate-filtering:
+    type: boolean
+    default: False
+    description: |
+      This setting allows the scheduler to restrict hosts in aggregates based
+      on matching required traits in the aggregate metadata and the instance
+      flavor/image. If an aggregate is configured with a property with key
+      trait:$TRAIT_NAME and value required, the instance flavor extra_specs
+      and/or image metadata must also contain trait:$TRAIT_NAME=required to be
+      eligible to be scheduled to hosts in that aggregate.
+      .
+      Set this option to True if you require that only instances with matching
+      traits (via flavor or image metadata) be placed on particular
+      hosts. This may also be a suitable workaround approach if you need to
+      give a tenant or tenants exclusivity for a compute host or set of hosts
+      (through the use of a custom trait) but otherwise want placement to
+      function normally for other hosts.
+      .
+      After enabling this option, follow
+      https://docs.openstack.org/nova/latest/reference/isolate-aggregates.html
+      for details on creating and creating and configuring traits, resource
+      providers and host aggregates.
+      .
+      Also see the limit-tenants-to-placement-aggregate and
+      placement-aggregate-required-for-tenants options.
+      .
+      This is only supported on OpenStack Train or later releases.

hooks/nova_cc_context.py

@@ -447,6 +447,12 @@ class NovaConfigContext(ch_context.WorkerConfigContext):
         ctxt['unique_server_names'] = hookenv.config('unique-server-names')
         ctxt['skip_hosts_with_build_failures'] = hookenv.config(
             'skip-hosts-with-build-failures')
+        ctxt['limit_tenants_to_placement_aggregate'] = hookenv.config(
+            'limit-tenants-to-placement-aggregate')
+        ctxt['placement_aggregate_required_for_tenants'] = hookenv.config(
+            'placement-aggregate-required-for-tenants')
+        ctxt['enable_isolated_aggregate_filtering'] = hookenv.config(
+            'enable-isolated-aggregate-filtering')
         return ctxt
 
 

templates/train/nova.conf

@@ -209,6 +209,16 @@ discover_hosts_in_cells_interval = 30
 
 workers = {{ workers }}
 
+{% if limit_tenants_to_placement_aggregate -%}
+limit_tenants_to_placement_aggregate = True
+{%- endif %}
+{%- if placement_aggregate_required_for_tenants %}
+placement_aggregate_required_for_tenants = True
+{%- endif %}
+{%- if enable_isolated_aggregate_filtering %}
+enable_isolated_aggregate_filtering = True
+{%- endif %}
+
 [filter_scheduler]
 {% if additional_neutron_filters is defined %}
 enabled_filters = {{ scheduler_default_filters }},{{ additional_neutron_filters }}

unit_tests/test_nova_cc_contexts.py

@@ -393,6 +393,14 @@ class NovaComputeContextTests(CharmTestCase):
                          self.config('unique-server-names'))
         self.assertEqual(ctxt['skip_hosts_with_build_failures'],
                          self.config('skip-hosts-with-build-failures'))
+        self.assertEqual(ctxt['limit_tenants_to_placement_aggregate'],
+                         self.config('limit-tenants-to-placement-aggregate'))
+        self.assertEqual(
+            ctxt["placement_aggregate_required_for_tenants"],
+            self.config("placement-aggregate-required-for-tenants"),
+        )
+        self.assertEqual(ctxt['enable_isolated_aggregate_filtering'],
+                         self.config('enable-isolated-aggregate-filtering'))
 
     _pci_alias1 = {
         "name": "IntelNIC",