Project

General

Profile

HostUnification » History » Version 16

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

1 1 Justin Sherrill
h1. Host Unification
2 2 Justin Sherrill
3
4 6 Justin Sherrill
h2. Goals
5 1 Justin Sherrill
6 6 Justin Sherrill
h3. Main Goal
7
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
* Split apart content and subscription information & logic
16 1 Justin Sherrill
17 13 Justin Sherrill
h4. Non-Goals
18 6 Justin Sherrill
19
* Unified host UI
20 2 Justin Sherrill
21 3 Justin Sherrill
h2. Design
22 2 Justin Sherrill
23
h4. Ideal Design
24
We have presented two designs, one design based somewhat on this discussion:
25
26
https://groups.google.com/forum/#!searchin/foreman-dev/shim/foreman-dev/9ByQmAtKokQ/W2V924xqtYUJ
27
28 4 Justin Sherrill
!http://projects.theforeman.org/attachments/download/1239/aspect.png!
29 2 Justin Sherrill
30
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
32
h4. Fallback design:
33
34
If this does not go favourably, we present this alternative design which is very similar but simpler in nature:
35
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
40 3 Justin Sherrill
41
h2. Api/Cli changes
42
43
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
45 5 Justin Sherrill
There are currently two designs:
46
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
   GET /api/v2/hosts?search="content_attr=foo"&include[]=content
53
   GET /api/v2/hosts/:id?include[]=content
54
   GET /api/v2/hosts/:id?include[]=subscriptions
55
   PUT /api/v2/hosts/:id/packages/install
56
</pre>
57 1 Justin Sherrill
58 7 Justin Sherrill
<pre>
59
  PUT /api/v2/hosts/3/  {'content_view_id': 5}
60
</pre>
61
62
Hammer commands:
63
64
<pre>
65
  hammer host details --id=3
66
  hammer host update --content-view=myView
67
  hammer host errata apply --host-id=3 --errata-ids=RHSA-2014:3
68
</pre>
69
70
71 5 Justin Sherrill
h3. Split Api
72
73 3 Justin Sherrill
The apis for interacting with the different aspects:
74
75
<pre>
76
   GET /api/v2/hosts?search="content_attr=foo"
77
   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
82
  to update a host's content:
83
84
<pre>
85
  PUT /api/v2/hosts/3/  {'content_view_id': 5}
86
  OR
87
  PUT /api/v2/hosts/3/content {'content_view_id': 5}
88
</pre>
89
90
Sample hammer commands
91
92
<pre>
93
  hammer host content details --id=3
94
  hammer host content update --content-view=myView
95
  hammer host content errata apply --host-id=3 --errata-ids=RHSA-2014:3
96
</pre>
97
98
99
h2. User Stories (P1): 
100
101 1 Justin Sherrill
(1 man sprint = 20 points)
102
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
* As a developer, i want to migrate the existing content host model to the new unified models for content and subscriptions (10)
109
* As a developer, I want to migrate all the existing content host dynflow  actions to use the new unified model (4)
110
* As a user, i want an upgrade provided to move existing content-hosts to the new unified models (4)
111
* As a developer, I want to pull system packages into the database (3)
112
* As a user, I should be able to search hosts by content attributes (2)
113
* As a user, I should be able to search hosts by subscription attributes (2)
114
* 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
* As a user, bulk actions should be based off hosts instead of content hosts (4)
117
* 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
* 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
* 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
* 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
* As a user, i expect the subscription and content aspects of hosts to be identified by their host id, not a uuid (3)
125
* As a user, i expect to be able to find the uuid of a host with subscriptions within the UI/hammer  (1)
126
* As a user, i expect to be able to search hosts by applicable errata (.5)
127
* 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
131
H2. User Stories (P2)
132
133 16 Justin Sherrill
(Unified Api)
134 12 Justin Sherrill
* As a developer, I want an api to inject new apipie params into the params of host & hostgroup Create/Update (5)
135
* As a developer, I want an api to define different rabl 'views' of a host/hostgroup (5)
136
* As a user, I want to be able to specify what views to render for my host (3)
137
138 1 Justin Sherrill
* As a user, i expect an api for interacting with content and subscription aspects of hosts (6)
139
* 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)
140 16 Justin Sherrill
141
(Unified Api)
142 12 Justin Sherrill
* As a hammer developer, I want to be able to inject attributes to display on an info command (4)
143
* As a hammer developer, I want to be able to inject parameters into the GET request of a particular info command (8)
144 10 Justin Sherrill
* As a user, I want to see content and subscription related items when running 'hammer host info' (1)
145 16 Justin Sherrill
146
147 10 Justin Sherrill
* As a user, i expect the following hammer commands to be migrated:
148 15 Justin Sherrill
** hammer content-host errata apply                      (.5)
149
** hammer content-host errata info                     (.5)
150
** hammer content-host errata list                        (.5)
151
** hammer content-host package install                (.5)
152
** hammer content-host package remove               (.5)
153
** hammer content-host package upgrade           e (.5)
154
** hammer content-host package upgrade-all         (.5)
155
** hammer content-host package-group install      (.5)
156
** hammer content-host package-group remove      (.5)
157
** hammer content-host update   (for updating content view, lifecycle environment) (.5) 
158
** hammer content-host update  (for updating service-level, release-version) (.5)
159
** hammer host puppet-classes (.5)
160
** hammer host puppetrun (.5)
161 5 Justin Sherrill
162 1 Justin Sherrill
163
H2 User Stories (P3)
164
* As a developer, I want to pull in subscriptions and related hosts into the database (7)
165
* As a user, I expect to search for hosts by their subscriptions (.5)