Project

General

Profile

HostUnification » History » Version 15

Justin Sherrill, 05/04/2015 03:15 PM

1 1 Justin Sherrill
h1. Host Unification
2 2 Justin Sherrill
3 2 Justin Sherrill
4 6 Justin Sherrill
h2. Goals
5 1 Justin Sherrill
6 6 Justin Sherrill
h3. Main Goal
7 6 Justin Sherrill
8 1 Justin Sherrill
* Unify "Content Hosts" and Hosts so that they are one object based on a 'Host'.  The content and subscription portions simply become attributes/concerns/aspects of a Host object.
9 2 Justin Sherrill
10 6 Justin Sherrill
h3. Secondary Goals
11 1 Justin Sherrill
12 6 Justin Sherrill
* Create a supported API for katello content and subscription aspects of a host
13 14 Justin Sherrill
* Plan and implement a generic way for Host objects to be split up and be plugable.  The host would have different aspects such as Puppet, Provisioning, & Content, any of which are optional.
14 13 Justin Sherrill
* Migrate Content Hosts to scoped search
15 13 Justin Sherrill
* Split apart content and subscription information & logic
16 1 Justin Sherrill
17 13 Justin Sherrill
h4. Non-Goals
18 6 Justin Sherrill
19 6 Justin Sherrill
* Unified host UI
20 2 Justin Sherrill
21 3 Justin Sherrill
h2. Design
22 2 Justin Sherrill
23 2 Justin Sherrill
h4. Ideal Design
24 2 Justin Sherrill
We have presented two designs, one design based somewhat on this discussion:
25 2 Justin Sherrill
26 2 Justin Sherrill
https://groups.google.com/forum/#!searchin/foreman-dev/shim/foreman-dev/9ByQmAtKokQ/W2V924xqtYUJ
27 2 Justin Sherrill
28 4 Justin Sherrill
!http://projects.theforeman.org/attachments/download/1239/aspect.png!
29 2 Justin Sherrill
30 2 Justin Sherrill
The goal is to open a pull request with this design implemented for the Puppet related portion and if feedback is positive to proceed with the Content and Subscription portions.
31 2 Justin Sherrill
32 2 Justin Sherrill
h4. Fallback design:
33 2 Justin Sherrill
34 2 Justin Sherrill
If this does not go favourably, we present this alternative design which is very similar but simpler in nature:
35 2 Justin Sherrill
36 1 Justin Sherrill
!http://projects.theforeman.org/attachments/download/1229/simple.png!
37 3 Justin Sherrill
38 9 Justin Sherrill
Host Group attributes today (Content view, Lifecycle Environment) would remain on the Host Group Object
39 9 Justin Sherrill
40 3 Justin Sherrill
41 3 Justin Sherrill
h2. Api/Cli changes
42 3 Justin Sherrill
43 3 Justin Sherrill
At a minimum, no api/cli changes would be needed and all functionality could remain with the proposed designs using existing controllers and cli commands.  However given that the current katello systems controller is 'deprecated', we greatly need to plan for a supported api.  Based on the discussions here: https://groups.google.com/forum/#!topic/foreman-dev/4Y4qxyknMwI
44 3 Justin Sherrill
45 5 Justin Sherrill
There are currently two designs:
46 5 Justin Sherrill
47 7 Justin Sherrill
h3. Unified Api Design
48 1 Justin Sherrill
49 7 Justin Sherrill
From a user perspective all aspects would appear as a single resource and would all be contained within that resource.  include[] could be passed on index and show to include the various aspects:
50 1 Justin Sherrill
51 7 Justin Sherrill
<pre>
52 7 Justin Sherrill
   GET /api/v2/hosts?search="content_attr=foo"&include[]=content
53 7 Justin Sherrill
   GET /api/v2/hosts/:id?include[]=content
54 7 Justin Sherrill
   GET /api/v2/hosts/:id?include[]=subscriptions
55 7 Justin Sherrill
   PUT /api/v2/hosts/:id/packages/install
56 7 Justin Sherrill
</pre>
57 1 Justin Sherrill
58 7 Justin Sherrill
<pre>
59 7 Justin Sherrill
  PUT /api/v2/hosts/3/  {'content_view_id': 5}
60 7 Justin Sherrill
</pre>
61 7 Justin Sherrill
62 7 Justin Sherrill
Hammer commands:
63 7 Justin Sherrill
64 7 Justin Sherrill
<pre>
65 7 Justin Sherrill
  hammer host details --id=3
66 7 Justin Sherrill
  hammer host update --content-view=myView
67 7 Justin Sherrill
  hammer host errata apply --host-id=3 --errata-ids=RHSA-2014:3
68 7 Justin Sherrill
</pre>
69 7 Justin Sherrill
70 7 Justin Sherrill
71 5 Justin Sherrill
h3. Split Api
72 5 Justin Sherrill
73 3 Justin Sherrill
The apis for interacting with the different aspects:
74 3 Justin Sherrill
75 3 Justin Sherrill
<pre>
76 3 Justin Sherrill
   GET /api/v2/hosts?search="content_attr=foo"
77 3 Justin Sherrill
   GET /api/v2/hosts/:id/content/
78 1 Justin Sherrill
   GET /api/v2/hosts/:id/subscription/
79 7 Justin Sherrill
   PUT /api/v2/hosts/:id/content/packages/install
80 3 Justin Sherrill
</pre>
81 3 Justin Sherrill
82 3 Justin Sherrill
  to update a host's content:
83 3 Justin Sherrill
84 3 Justin Sherrill
<pre>
85 3 Justin Sherrill
  PUT /api/v2/hosts/3/  {'content_view_id': 5}
86 3 Justin Sherrill
  OR
87 3 Justin Sherrill
  PUT /api/v2/hosts/3/content {'content_view_id': 5}
88 3 Justin Sherrill
</pre>
89 3 Justin Sherrill
90 3 Justin Sherrill
Sample hammer commands
91 3 Justin Sherrill
92 3 Justin Sherrill
<pre>
93 3 Justin Sherrill
  hammer host content details --id=3
94 3 Justin Sherrill
  hammer host content update --content-view=myView
95 3 Justin Sherrill
  hammer host content errata apply --host-id=3 --errata-ids=RHSA-2014:3
96 3 Justin Sherrill
</pre>
97 3 Justin Sherrill
98 3 Justin Sherrill
99 3 Justin Sherrill
h2. User Stories (P1): 
100 3 Justin Sherrill
101 1 Justin Sherrill
(1 man sprint = 20 points)
102 1 Justin Sherrill
103 5 Justin Sherrill
* As a user, I should be able to create a host without a puppet environment (2)
104 11 Justin Sherrill
  OR
105 5 Justin Sherrill
* As a developer, I want to split out all puppet concerns to their own 'aspect' (10)
106 11 Justin Sherrill
107 3 Justin Sherrill
* As a  user, i expect host create/update/delete to be dynflowed (wrapping the  AR action), via foreman_tasks or in core to allow plugins to hook into  CUD to interact with backend services (4)
108 3 Justin Sherrill
* As a developer, i want to migrate the existing content host model to the new unified models for content and subscriptions (10)
109 3 Justin Sherrill
* As a developer, I want to migrate all the existing content host dynflow  actions to use the new unified model (4)
110 3 Justin Sherrill
* As a user, i want an upgrade provided to move existing content-hosts to the new unified models (4)
111 3 Justin Sherrill
* As a developer, I want to pull system packages into the database (3)
112 3 Justin Sherrill
* As a user, I should be able to search hosts by content attributes (2)
113 3 Justin Sherrill
* As a user, I should be able to search hosts by subscription attributes (2)
114 3 Justin Sherrill
* As a user, I expect subscription facts to live alongside puppet facts.  (4)
115 10 Justin Sherrill
* As a user, I should be able to add & remove hosts to host collections instead of content-hosts (5)
116 10 Justin Sherrill
* As a user, bulk actions should be based off hosts instead of content hosts (4)
117 10 Justin Sherrill
* As a  user, I should be able to register a host with subscription-manager via username and password with the new data model, and a Host should be created (4)
118 10 Justin Sherrill
* As a user, I should be able to register a host with subscription-manager via activation key with the new data model, and a Host should be created (4)
119 10 Justin Sherrill
* As a user, I should be able to register with subscription-manager to an existing host that has never registered with sub-man before (3)
120 10 Justin Sherrill
* As a user, I should be able to register with subscription-manager to an existing host that has previously registered with subscription-manager, and have the old registration be removed, generating a new UUID (3)
121 3 Justin Sherrill
* As a user, virt-who should continue to work with the new unified model, including hypervisor registration.  An hypervisor registered through virt-who would have content capabilities. (5)
122 5 Justin Sherrill
* As a user, i expect package profile uploading to continue to work under the unified model (2)
123 3 Justin Sherrill
* As a user, i expect client actions (errata install, package install, etc..) to continue to work under the unified model (3)
124 3 Justin Sherrill
* As a user, i expect the subscription and content aspects of hosts to be identified by their host id, not a uuid (3)
125 3 Justin Sherrill
* As a user, i expect to be able to find the uuid of a host with subscriptions within the UI/hammer  (1)
126 3 Justin Sherrill
* As a user, i expect to be able to search hosts by applicable errata (.5)
127 3 Justin Sherrill
* As a user, i expect to be able to search hosts by installed package (.5)
128 1 Justin Sherrill
* As a user, i expect to be able to search hosts by subscription facts (.5)
129 3 Justin Sherrill
* As a user, i expect existing apis (and thus hammer commands and the UI) to continue to work under the new model, if new apis are not added (8)
130 3 Justin Sherrill
131 3 Justin Sherrill
H2. User Stories (P2)
132 3 Justin Sherrill
133 12 Justin Sherrill
* As a developer, I want an api to inject new apipie params into the params of host & hostgroup Create/Update (5)
134 12 Justin Sherrill
* As a developer, I want an api to define different rabl 'views' of a host/hostgroup (5)
135 12 Justin Sherrill
* As a user, I want to be able to specify what views to render for my host (3)
136 12 Justin Sherrill
137 1 Justin Sherrill
* As a user, i expect an api for interacting with content and subscription aspects of hosts (6)
138 1 Justin Sherrill
* As  a developer, the content hosts UI needs to utilize new v2 apis for interacting with the subscription and content aspects of a host (8)
139 12 Justin Sherrill
* As a hammer developer, I want to be able to inject attributes to display on an info command (4)
140 12 Justin Sherrill
* As a hammer developer, I want to be able to inject parameters into the GET request of a particular info command (8)
141 10 Justin Sherrill
* As a user, I want to see content and subscription related items when running 'hammer host info' (1)
142 10 Justin Sherrill
* As a user, i expect the following hammer commands to be migrated:
143 15 Justin Sherrill
** hammer content-host errata apply                      (.5)
144 15 Justin Sherrill
** hammer content-host errata info                     (.5)
145 15 Justin Sherrill
** hammer content-host errata list                        (.5)
146 15 Justin Sherrill
** hammer content-host package install                (.5)
147 15 Justin Sherrill
** hammer content-host package remove               (.5)
148 15 Justin Sherrill
** hammer content-host package upgrade           e (.5)
149 15 Justin Sherrill
** hammer content-host package upgrade-all         (.5)
150 15 Justin Sherrill
** hammer content-host package-group install      (.5)
151 15 Justin Sherrill
** hammer content-host package-group remove      (.5)
152 15 Justin Sherrill
** hammer content-host update   (for updating content view, lifecycle environment) (.5) 
153 15 Justin Sherrill
** hammer content-host update  (for updating service-level, release-version) (.5)
154 15 Justin Sherrill
** hammer host puppet-classes (.5)
155 15 Justin Sherrill
** hammer host puppetrun (.5)
156 5 Justin Sherrill
157 1 Justin Sherrill
158 1 Justin Sherrill
H2 User Stories (P3)
159 1 Justin Sherrill
* As a developer, I want to pull in subscriptions and related hosts into the database (7)
160 1 Justin Sherrill
* As a user, I expect to search for hosts by their subscriptions (.5)