Introduce OS::TripleO::Services::Rhsm

Background: extraconfig/pre_deploy/rhel-registration interface has been maintained for some time now but it's missing some features and the code overlaps with ongoing efforts to convert everything to Ansible. Plan: Consume ansible-role-redhat-subscription from TripleO, so all the logics goes into the Ansible role, and not in TripleO anymore. The single parameter exposed to TripleO is RhsmVars and any Ansible parameter can be given to make the role working. The parameter can be overriden per roles, so we can think at specific cases were some Director roles would have specific RHSM configs. Once we have feature parity between what is done and what was here before, we'll deprecate the old interface. Testing: Because RHSM can't be tested on CentOS, this code was manually tested on RHEL against the public subscription portal. Also, we verified that generated Ansible playbooks were correct and called the role with the right parameters. Documentation: We'll work on documentation during the following weeks and explain how to switch from the previous interface to the new one, and also document new uses requested by our users. Change-Id: I8610e4f1f8478f2dcbe3afc319981df914ce1780
2017-12-08 17:14:33 -08:00 · 2017-12-08 17:14:33 -08:00 · 6a6872f390
parent bacacf79e2
commit 6a6872f390
36 changed files with 151 additions and 0 deletions
--- a/environments/hyperconverged-ceph.yaml
+++ b/environments/hyperconverged-ceph.yaml
@ -54,4 +54,5 @@ parameter_defaults:
    - OS::TripleO::Services::OVNController
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::LoginDefs
+    - OS::TripleO::Services::Rhsm

--- a/environments/rhsm.yaml
+++ b/environments/rhsm.yaml
@ -0,0 +1,35 @@
+# A Heat environment file that enables RHSM.
+
+resource_registry:
+  OS::TripleO::Services::Rhsm: ../extraconfig/services/rhsm.yaml
+
+parameter_defaults:
+# RhsmVars:
+#   rhsub_repos:
+#     - rhel-7-server-rpms
+#     - rhel-7-server-extras-rpms
+#     - rhel-7-server-rh-common-rpms
+#     - rhel-ha-for-rhel-7-server-rpms
+#     - rhel-7-server-openstack-13-rpms
+#   rhn_activation_key: 'secrete-key'
+
+
+# In some cases, you want to configure specific repos on some roles.
+# Each role can have its own RHSM configuration.
+# Example:
+# ComputeHCIParameters:
+#   RhsmVars:
+#     rhsub_repos:
+#       - rhel-7-server-rpms
+#       - rhel-7-server-extras-rpms
+#       - rhel-7-server-rh-common-rpms
+#       - rhel-ha-for-rhel-7-server-rpms
+#       - rhel-7-server-openstack-13-rpms
+#       - rhel-7-server-rhceph-1.3-osd-rpms
+#     rhn_activation_key: 'anothersecrete-key'
+#
+# More about composable roles:
+# https://docs.openstack.org/tripleo-docs/latest/install/advanced_deployment/role_specific_parameters.html
+#
+# More about ansible-role-redhat-subscription variables:
+# https://github.com/openstack/ansible-role-redhat-subscription
--- a/extraconfig/services/rhsm.yaml
+++ b/extraconfig/services/rhsm.yaml
@ -0,0 +1,74 @@
+heat_template_version: queens
+
+description: Configure Red Hat Subscription Management.
+
+parameters:
+  RoleNetIpMap:
+    default: {}
+    type: json
+  ServiceData:
+    default: {}
+    description: Dictionary packing service data
+    type: json
+  ServiceNetMap:
+    default: {}
+    description: Mapping of service_name -> network name. Typically set
+                 via parameter_defaults in the resource registry.  This
+                 mapping overrides those in ServiceNetMapDefaults.
+    type: json
+  DefaultPasswords:
+    default: {}
+    type: json
+  RoleName:
+    default: ''
+    description: Role name on which the service is applied
+    type: string
+  RoleParameters:
+    default: {}
+    description: Parameters specific to the role
+    type: json
+  EndpointMap:
+    default: {}
+    description: Mapping of service endpoint -> protocol. Typically set
+                 via parameter_defaults in the resource registry.
+    type: json
+  RhsmVars:
+    default: {}
+    description: Hash of ansible-role-redhat-subscription variables
+                 used to configure RHSM.
+    # The parameters contains sensible data like activation key or password.
+    hidden: true
+    tags:
+      - role_specific
+    type: json
+
+resources:
+  # Merging role-specific parameters (RoleParameters) with the default parameters.
+  # RoleParameters will have the precedence over the default parameters.
+  RoleParametersValue:
+    type: OS::Heat::Value
+    properties:
+      type: json
+      value:
+        map_replace:
+          - map_replace:
+            - vars: RhsmVars
+            - values: {get_param: [RoleParameters]}
+          - values:
+              vars: {get_param: RhsmVars}
+
+outputs:
+  role_data:
+    description: Role data for the RHSM service.
+    value:
+      service_name: rhsm
+      config_settings:
+        tripleo::rhsm::firewall_rules: {}
+      upgrade_tasks: []
+      step_config: ''
+      host_prep_tasks:
+        - name: Red Hat Subscription Management configuration
+          vars: {get_attr: [RoleParametersValue, value, vars]}
+          block:
+          - include_role:
+              name: redhat-subscription
--- a/overcloud-resource-registry-puppet.j2.yaml
+++ b/overcloud-resource-registry-puppet.j2.yaml
@ -238,6 +238,7 @@ resource_registry:
  # Services that are disabled by default (use relevant environment files):
  OS::TripleO::Services::Fluentd: OS::Heat::None
  OS::TripleO::Services::Ipsec: OS::Heat::None
+  OS::TripleO::Services::Rhsm: OS::Heat::None
  OS::TripleO::Services::Collectd: OS::Heat::None
  OS::TripleO::LoggingConfiguration: puppet/services/logging/fluentd-config.yaml
  OS::TripleO::Services::ManilaApi: OS::Heat::None
--- a/releasenotes/notes/rhsm-service-fbec46930264b355.yaml
+++ b/releasenotes/notes/rhsm-service-fbec46930264b355.yaml
@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Introduce a new service to configure RHSM with Ansible,
+    by calling ansible-role-redhat-subscription in host_prep_tasks.
--- a/roles/BlockStorage.yaml
+++ b/roles/BlockStorage.yaml
@ -24,6 +24,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/CephAll.yaml
+++ b/roles/CephAll.yaml
@ -28,6 +28,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/CephFile.yaml
+++ b/roles/CephFile.yaml
@ -24,6 +24,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/CephObject.yaml
+++ b/roles/CephObject.yaml
@ -24,6 +24,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/CephStorage.yaml
+++ b/roles/CephStorage.yaml
@ -21,6 +21,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/Compute.yaml
+++ b/roles/Compute.yaml
@ -48,6 +48,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/ComputeAlt.yaml
+++ b/roles/ComputeAlt.yaml
@ -36,6 +36,7 @@
    - OS::TripleO::Services::NovaMigrationTargetAlt
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClientAlt
    - OS::TripleO::Services::SkydiveAgent
--- a/roles/ComputeHCI.yaml
+++ b/roles/ComputeHCI.yaml
@ -39,6 +39,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/ComputeLiquidio.yaml
+++ b/roles/ComputeLiquidio.yaml
@ -33,6 +33,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::LiquidioCompute
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::Snmp
    - OS::TripleO::Services::Sshd
--- a/roles/ComputeOvsDpdk.yaml
+++ b/roles/ComputeOvsDpdk.yaml
@ -37,6 +37,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/ComputeSriov.yaml
+++ b/roles/ComputeSriov.yaml
@ -40,6 +40,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/Controller.yaml
+++ b/roles/Controller.yaml
@ -131,6 +131,7 @@
    - OS::TripleO::Services::PankoApi
    - OS::TripleO::Services::RabbitMQ
    - OS::TripleO::Services::Redis
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::SaharaApi
    - OS::TripleO::Services::SaharaEngine
--- a/roles/ControllerAllNovaStandalone.yaml
+++ b/roles/ControllerAllNovaStandalone.yaml
@ -93,6 +93,7 @@
    - OS::TripleO::Services::Pacemaker
    - OS::TripleO::Services::PankoApi
    - OS::TripleO::Services::Redis
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::SaharaApi
    - OS::TripleO::Services::SaharaEngine
--- a/roles/ControllerNoCeph.yaml
+++ b/roles/ControllerNoCeph.yaml
@ -126,6 +126,7 @@
    - OS::TripleO::Services::PankoApi
    - OS::TripleO::Services::RabbitMQ
    - OS::TripleO::Services::Redis
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::SaharaApi
    - OS::TripleO::Services::SaharaEngine
--- a/roles/ControllerNovaStandalone.yaml
+++ b/roles/ControllerNovaStandalone.yaml
@ -113,6 +113,7 @@
    - OS::TripleO::Services::PankoApi
    - OS::TripleO::Services::RabbitMQ
    - OS::TripleO::Services::Redis
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::SaharaApi
    - OS::TripleO::Services::SaharaEngine
--- a/roles/ControllerOpenstack.yaml
+++ b/roles/ControllerOpenstack.yaml
@ -104,6 +104,7 @@
    - OS::TripleO::Services::Pacemaker
    - OS::TripleO::Services::PankoApi
    - OS::TripleO::Services::Redis
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::SaharaApi
    - OS::TripleO::Services::SaharaEngine
--- a/roles/Database.yaml
+++ b/roles/Database.yaml
@ -23,6 +23,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::Pacemaker
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::SensuClient
    - OS::TripleO::Services::Snmp
--- a/roles/HciCephAll.yaml
+++ b/roles/HciCephAll.yaml
@ -45,6 +45,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/HciCephFile.yaml
+++ b/roles/HciCephFile.yaml
@ -41,6 +41,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/HciCephMon.yaml
+++ b/roles/HciCephMon.yaml
@ -42,6 +42,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/HciCephObject.yaml
+++ b/roles/HciCephObject.yaml
@ -41,6 +41,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/IronicConductor.yaml
+++ b/roles/IronicConductor.yaml
@ -20,6 +20,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::SensuClient
    - OS::TripleO::Services::Snmp
    - OS::TripleO::Services::Timezone
--- a/roles/Messaging.yaml
+++ b/roles/Messaging.yaml
@ -21,6 +21,7 @@
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::Pacemaker
    - OS::TripleO::Services::RabbitMQ
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::SensuClient
    - OS::TripleO::Services::Snmp
    - OS::TripleO::Services::Timezone
--- a/roles/Networker.yaml
+++ b/roles/Networker.yaml
@ -31,6 +31,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::SensuClient
    - OS::TripleO::Services::SkydiveAgent
    - OS::TripleO::Services::Snmp
--- a/roles/Novacontrol.yaml
+++ b/roles/Novacontrol.yaml
@ -30,6 +30,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
    - OS::TripleO::Services::SkydiveAgent
--- a/roles/ObjectStorage.yaml
+++ b/roles/ObjectStorage.yaml
@ -29,6 +29,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles/Telemetry.yaml
+++ b/roles/Telemetry.yaml
@ -29,6 +29,7 @@
    - OS::TripleO::Services::PankoApi
    - OS::TripleO::Services::RabbitMQ
    - OS::TripleO::Services::Redis
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::Timezone
    - OS::TripleO::Services::TripleoFirewall
    - OS::TripleO::Services::TripleoPackages
--- a/roles/Undercloud.yaml
+++ b/roles/Undercloud.yaml
@ -46,6 +46,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::RabbitMQ
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::SwiftProxy
    - OS::TripleO::Services::SwiftRingBuilder
    - OS::TripleO::Services::SwiftStorage
--- a/roles/UndercloudLight.yaml
+++ b/roles/UndercloudLight.yaml
@ -31,6 +31,7 @@
    - OS::TripleO::Services::NeutronDhcpAgent
    - OS::TripleO::Services::NeutronServer
    - OS::TripleO::Services::RabbitMQ
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::SwiftProxy
    - OS::TripleO::Services::SwiftRingBuilder
    - OS::TripleO::Services::SwiftStorage
--- a/roles_data.yaml
+++ b/roles_data.yaml
@ -134,6 +134,7 @@
    - OS::TripleO::Services::PankoApi
    - OS::TripleO::Services::RabbitMQ
    - OS::TripleO::Services::Redis
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::SaharaApi
    - OS::TripleO::Services::SaharaEngine
@ -204,6 +205,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::OpenDaylightOvs
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
@ -242,6 +244,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
@ -282,6 +285,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
@ -316,6 +320,7 @@
    - OS::TripleO::Services::MySQLClient
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::RsyslogSidecar
    - OS::TripleO::Services::Securetty
    - OS::TripleO::Services::SensuClient
--- a/roles_data_undercloud.yaml
+++ b/roles_data_undercloud.yaml
@ -49,6 +49,7 @@
    - OS::TripleO::Services::Ntp
    - OS::TripleO::Services::ContainersLogrotateCrond
    - OS::TripleO::Services::RabbitMQ
+    - OS::TripleO::Services::Rhsm
    - OS::TripleO::Services::SwiftProxy
    - OS::TripleO::Services::SwiftRingBuilder
    - OS::TripleO::Services::SwiftStorage