Merge "Cyborg deployment script"

.gitignore

@@ -1,5 +1,6 @@
 *.pyc
 *.tox
+*.retry
 *.testrepository
 cyborg.egg-info
 

cyborg/agent/__init__.py

@@ -1,19 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Licensed under the Apache License, Version 2.0 (the "License"); you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
-
-import pbr.version
-
-
-__version__ = pbr.version.VersionInfo(
-    'cyborg-agent').version_string()

cyborg/agent/agent.conf

@@ -1,3 +0,0 @@
-[cyborg]
-transport_url=
-server_id=

cyborg/agent/agent.py

@@ -1,64 +0,0 @@
-# -*- coding: utf-8 -*-
-
-#
-# Licensed under the Apache License, Version 2.0 (the "License"); you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
-
-import conf
-import eventlet
-from oslo_config import cfg
-from oslo_log import log as logging
-import oslo_messaging as messaging
-import rpcapi
-import time
-
-eventlet.monkey_patch()
-
-CONF = cfg.CONF
-
-conf.register_opts(CONF)
-
-LOG = logging.getLogger(__name__)
-logging.register_options(CONF)
-logging.setup(CONF, 'Cyborg.Agent')
-
-CONF(['--config-file', 'agent.conf'])
-
-url = messaging.TransportURL.parse(CONF, url=CONF.cyborg.transport_url)
-transport = messaging.get_notification_transport(CONF, url)
-
-notifier = messaging.Notifier(transport,
-                              driver='messaging',
-                              publisher_id='Cyborg.Agent',
-                              topic='info')
-
-rpc_targets = messaging.Target(topic='cyborg_control',
-                               server=CONF.cyborg.server_id)
-rpc_endpoints = [
-    rpcapi.RPCEndpoint()
-]
-access_policy = messaging.ExplicitRPCAccessPolicy
-rpc_server = messaging.get_rpc_server(transport,
-                                      rpc_targets,
-                                      rpc_endpoints,
-                                      executor='eventlet',
-                                      access_policy=access_policy)
-
-try:
-    print("Cyborg Agent running")
-    rpc_server.start()
-    while True:
-        time.sleep(1)
-except KeyboardInterrupt:
-    print("Stopping server")
-    rpc_server.stop()
-    rpc_server.wait()

cyborg/agent/manager.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import oslo_messaging as messaging
+
+from cyborg.conf import CONF
+
+
+class AgentManager(object):
+    """Cyborg Agent manager main class."""
+
+    RPC_API_VERSION = '1.0'
+    target = messaging.Target(version=RPC_API_VERSION)
+
+    def __init__(self, topic, host=None):
+        super(AgentManager, self).__init__()
+        self.topic = topic
+        self.host = host or CONF.host
+
+    def periodic_tasks(self, context, raise_on_error=False):
+        pass
+
+    def hardware_list(self, context, values):
+        """List installed hardware."""
+        pass

cyborg/agent/rpcapi.py

@@ -13,18 +13,40 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+"""Client side of the conductor RPC API."""
 
-class RPCEndpoint(object):
+from oslo_config import cfg
+import oslo_messaging as messaging
 
-    # Conductor functions exposed for external calls
-    def __init__(self):
-        pass
-
-    def list_accelerators(self, ctxt):
-        pass
-
-    def update_accelerator(self, ctxt, accelerator):
-        pass
-
-    def discover_accelerators(self, ctxt):
+from cyborg.common import constants
+from cyborg.common import rpc
+from cyborg.objects import base as objects_base
+
+
+CONF = cfg.CONF
+
+
+class AgentAPI(object):
+    """Client side of the Agent RPC API.
+
+    API version history:
+
+    |    1.0 - Initial version.
+
+    """
+
+    RPC_API_VERSION = '1.0'
+
+    def __init__(self, topic=None):
+        super(AgentAPI, self).__init__()
+        self.topic = topic or constants.AGENT_TOPIC
+        target = messaging.Target(topic=self.topic,
+                                  version='1.0')
+        serializer = objects_base.CyborgObjectSerializer()
+        self.client = rpc.get_client(target,
+                                     version_cap=self.RPC_API_VERSION,
+                                     serializer=serializer)
+
+    def hardware_list(self, context, values):
+        """Signal the agent to find local hardware."""
         pass

cyborg/cmd/agent.py

@@ -11,18 +11,27 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+"""The Cyborg Agent Service."""
+
+import sys
+
 from oslo_config import cfg
-import uuid
+from oslo_service import service
 
-default_opts = [
-    cfg.StrOpt('transport_url',
-               default='',
-               help='Transport url to use for messaging'),
-    cfg.StrOpt('server_id',
-               default=uuid.uuid4(),
-               help='Unique identifier for this agent'),
-]
+from cyborg.common import constants
+from cyborg.common import service as cyborg_service
 
 
-def register_opts(conf):
-    conf.register_opts(default_opts, group='cyborg')
+CONF = cfg.CONF
+
+
+def main():
+    # Parse config file and command line options, then start logging
+    cyborg_service.prepare_service(sys.argv)
+
+    mgr = cyborg_service.RPCService('cyborg.agent.manager',
+                                    'AgentManager',
+                                    constants.AGENT_TOPIC)
+
+    launcher = service.launch(CONF, mgr)
+    launcher.wait()

cyborg/common/constants.py

@@ -15,3 +15,4 @@
 
 
 CONDUCTOR_TOPIC = 'cyborg-conductor'
+AGENT_TOPIC = 'cyborg-agent'

setup.cfg

@@ -31,6 +31,7 @@ console_scripts =
     cyborg-api = cyborg.cmd.api:main
     cyborg-conductor = cyborg.cmd.conductor:main
     cyborg-dbsync = cyborg.cmd.dbsync:main
+    cyborg-agent = cyborg.cmd.agent:main
 
 cyborg.database.migration_backend =
     sqlalchemy = cyborg.db.sqlalchemy.migration

setup/deploy-cyborg.yml

@@ -0,0 +1,22 @@
+---
+# This Ansible playbook deploys Cyborg services on an openstack cloud
+
+- hosts: controller
+  remote_user: heat-admin
+  roles:
+    - generate_credentials
+    - install_package
+    - template_config
+    - deploy_api
+    - deploy_conductor
+    - validate_api
+    - validate_conductor
+
+- hosts: compute
+  remote_user: heat-admin
+  roles:
+    - install_package
+    - template_config
+    - deploy_agent
+    - validate_agent
+    #- deploy_drivers

setup/roles/deploy_agent/tasks/main.yml

@@ -0,0 +1,22 @@
+---
+# Sets up Cyborg api to start at boot
+
+- name: Create Cyborg user
+  user:
+    name: cyborg
+    comment: "cyborg user"
+    createhome: no
+  become: true
+
+- name: Template service file for Cyborg Agent
+  template:
+    src: openstack-cyborg-agent.service.j2
+    dest: /usr/lib/systemd/system/openstack-cyborg-agent.service
+  become: true
+
+- name: Start service and set to run at boot
+  service:
+    name: openstack-cyborg-agent
+    state: started
+    enabled: yes
+  become: true

setup/roles/deploy_agent/templates/openstack-cyborg-agent.service.j2

@@ -0,0 +1,13 @@
+[Unit]
+Description=OpenStack Accelerator management service
+After=syslog.target network.target
+
+[Service]
+Type=simple
+User=cyborg
+ExecStart=/usr/bin/cyborg-agent
+PrivateTmp=true
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target

setup/roles/deploy_api/tasks/main.yml

@@ -0,0 +1,22 @@
+---
+# Sets up Cyborg api to start at boot
+
+- name: Create Cyborg user
+  user:
+    name: cyborg
+    comment: "cyborg user"
+    createhome: no
+  become: true
+
+- name: Template service file for Cyborg API
+  template:
+    src: openstack-cyborg-api.service.j2
+    dest: /usr/lib/systemd/system/openstack-cyborg-api.service
+  become: true
+
+- name: Start service and set to run at boot
+  service:
+    name: openstack-cyborg-api
+    state: started
+    enabled: yes
+  become: true

setup/roles/deploy_api/templates/openstack-cyborg-api.service.j2

@@ -0,0 +1,13 @@
+[Unit]
+Description=OpenStack Accelerator management service
+After=syslog.target network.target
+
+[Service]
+Type=simple
+User=cyborg
+ExecStart=/usr/bin/cyborg-api
+PrivateTmp=true
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target

setup/roles/deploy_conductor/tasks/main.yml

@@ -0,0 +1,22 @@
+---
+# Sets up Cyborg api to start at boot
+
+- name: Create Cyborg user
+  user:
+    name: cyborg
+    comment: "cyborg user"
+    createhome: no
+  become: true
+
+- name: Template service file for Cyborg Conductor
+  template:
+    src: openstack-cyborg-conductor.service.j2
+    dest: /usr/lib/systemd/system/openstack-cyborg-conductor.service
+  become: true
+
+- name: Start service and set to run at boot
+  service:
+    name: openstack-cyborg-conductor
+    state: started
+    enabled: yes
+  become: true

setup/roles/deploy_conductor/templates/openstack-cyborg-conductor.service.j2

@@ -0,0 +1,13 @@
+[Unit]
+Description=OpenStack Accelerator management service
+After=syslog.target network.target
+
+[Service]
+Type=simple
+User=glance
+ExecStart=/usr/bin/cyborg-conductor
+PrivateTmp=true
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target

setup/roles/generate_credentials/tasks/main.yml

@@ -0,0 +1,20 @@
+---
+
+- name: Create Cyborg mysql user
+  mysql_user:
+    name: cyborg
+    password: "{{ lookup('password', 'credentials/cyborg/mysqlpassword length=15') }}" # Generates a password
+    priv: '*.*:ALL,GRANT' # Do we only need the cyborg database?
+    state: present
+  become: true
+
+- name: Create Cyborg rabbitmq user
+  rabbitmq_user:
+    user: cyborg
+    password: "{{ lookup('password', 'credentials/cyborg/rabbitpassword length=15') }}" # Generates a password
+    vhost: /
+    read_priv: .*
+    write_priv: .*
+    configure_priv: .*
+    state: present
+  become: true

setup/roles/install_package/tasks/main.yml

@@ -0,0 +1,38 @@
+---
+
+- name: Check if pip is installed
+  shell: "which pip"
+  register: which_pip
+  ignore_errors: true
+
+- name: Install pip
+  package:
+    name: python-pip
+    state: present
+  when: which_pip|failed
+  become: true
+
+- name: Install rsync
+  package:
+    name: rsync
+    state: present
+  become: true
+
+- name: Copy cyborg to host
+  synchronize:
+    src: ../../../cyborg/
+    dest: /tmp/cyborg
+    use_ssh_args: yes
+
+- name: Remove old Cyborg if installed
+  pip:
+    name: cyborg
+    state: absent
+  become: true
+  ignore_errors: true
+
+- name: Install Cyborg using pip
+  pip:
+    name: /tmp/cyborg
+    state: present
+  become: true

setup/roles/template_config/tasks/main.yml

@@ -0,0 +1,13 @@
+---
+
+- name: Create cyborg config dir
+  file:
+    path: /etc/cyborg
+    state: directory
+  become: true
+
+- name: Template Cyborg.conf
+  template:
+    src: cyborg.conf.j2
+    dest: /etc/cyborg/cyborg.conf
+  become: true

setup/roles/template_config/templates/cyborg.conf.j2

@@ -0,0 +1,3 @@
+[DEFAULT]
+connection=mysql+pymysql://cyborg:{{ lookup('password', 'credentials/cyborg/rabbitpassword length=15') }}@overcloud-controller-0.internalapi/nova?read_default_file=/etc/my.cnf.d/tripleo.cnf&read_default_group=tripleo
+transport_url=rabbit://cyborg:{{ lookup('password', 'credentials/cyborg/rabbitpassword length=15') }}@overcloud-controller-0.internalapi:5672/?ssl=0

setup/roles/validate_agent/tasks/main.yml

@@ -0,0 +1,13 @@
+---
+
+- name: Check Agent status
+  service:
+    name: openstack-cyborg-agent
+    state: started
+    enabled: yes
+  become: true
+  register: result
+
+- name: Fail if Agent is not up
+  fail: msg="Cyborg Agent did not start correctly!"
+  when: result.status.ActiveState == "failed"

setup/roles/validate_api/tasks/main.yml

@@ -0,0 +1,21 @@
+---
+
+- name: Check API status
+  service:
+    name: openstack-cyborg-api
+    state: started
+    enabled: yes
+  become: true
+  register: result
+
+- name: Fail if API did not start
+  fail: msg="Cyborg API did not start correctly!"
+  when: result.status.ActiveState == "failed"
+
+- name: Make a request to the cyborg API endpoint
+  wait_for:
+    host: localhost
+    port: 6666
+    state: started
+    delay: 1
+    timeout: 60

setup/roles/validate_conductor/tasks/main.yml

@@ -0,0 +1,13 @@
+---
+
+- name: Check if Conductor is running
+  service:
+    name: openstack-cyborg-conductor
+    state: started
+    enabled: yes
+  become: true
+  register: result
+
+- name: Fail if Conductor is not running
+  fail: msg="Cyborg Conductor did not start correctly!"
+  when: result.status.ActiveState == "failed"