HostUnification » History » Version 5
Justin Sherrill, 05/04/2015 11:23 AM
1 | 1 | Justin Sherrill | h1. Host Unification |
---|---|---|---|
2 | 2 | Justin Sherrill | |
3 | |||
4 | h2. Main Goals |
||
5 | |||
6 | * 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. |
||
7 | * |
||
8 | |||
9 | |||
10 | |||
11 | 3 | Justin Sherrill | h2. Design |
12 | 2 | Justin Sherrill | |
13 | h4. Ideal Design |
||
14 | We have presented two designs, one design based somewhat on this discussion: |
||
15 | |||
16 | https://groups.google.com/forum/#!searchin/foreman-dev/shim/foreman-dev/9ByQmAtKokQ/W2V924xqtYUJ |
||
17 | |||
18 | 4 | Justin Sherrill | !http://projects.theforeman.org/attachments/download/1239/aspect.png! |
19 | 2 | Justin Sherrill | |
20 | 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. |
||
21 | |||
22 | h4. Fallback design: |
||
23 | |||
24 | If this does not go favourably, we present this alternative design which is very similar but simpler in nature: |
||
25 | |||
26 | 1 | Justin Sherrill | !http://projects.theforeman.org/attachments/download/1229/simple.png! |
27 | 3 | Justin Sherrill | |
28 | |||
29 | h2. Api/Cli changes |
||
30 | |||
31 | 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 |
||
32 | |||
33 | 5 | Justin Sherrill | There are currently two designs: |
34 | |||
35 | h4. Unified Api Design |
||
36 | |||
37 | |||
38 | |||
39 | h3. Split Api |
||
40 | |||
41 | 3 | Justin Sherrill | The apis for interacting with the different aspects: |
42 | |||
43 | <pre> |
||
44 | GET /api/v2/hosts?search="content_attr=foo" |
||
45 | GET /api/v2/hosts/:id/content/ |
||
46 | GET /api/v2/hosts/:id/subscription/ |
||
47 | </pre> |
||
48 | |||
49 | to update a host's content: |
||
50 | |||
51 | <pre> |
||
52 | PUT /api/v2/hosts/3/ {'content_view_id': 5} |
||
53 | OR |
||
54 | PUT /api/v2/hosts/3/content {'content_view_id': 5} |
||
55 | </pre> |
||
56 | |||
57 | Sample hammer commands |
||
58 | |||
59 | <pre> |
||
60 | hammer host content details --id=3 |
||
61 | hammer host content update --content-view=myView |
||
62 | hammer host content errata apply --host-id=3 --errata-ids=RHSA-2014:3 |
||
63 | </pre> |
||
64 | |||
65 | |||
66 | h2. User Stories (P1): |
||
67 | |||
68 | 1 | Justin Sherrill | (1 man sprint = 20 points) |
69 | |||
70 | 5 | Justin Sherrill | * As a user, I should be able to create a host without a puppet environment (2) |
71 | * As a developer, I want to split out all puppet concerns to their own 'aspect' (10) |
||
72 | 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) |
73 | * As a developer, i want to migrate the existing content host model to the new unified models for content and subscriptions (10) |
||
74 | * As a developer, I want to migrate all the existing content host dynflow actions to use the new unified model (4) |
||
75 | * As a user, i want an upgrade provided to move existing content-hosts to the new unified models (4) |
||
76 | * As a developer, I want to pull system packages into the database (3) |
||
77 | * As a user, I should be able to search hosts by content attributes (2) |
||
78 | * As a user, I should be able to search hosts by subscription attributes (2) |
||
79 | * As a user, I expect subscription facts to live alongside puppet facts. (4) |
||
80 | * As a user, I should be able to add & remove hosts to host collections instead of content-hosts (4) |
||
81 | * As a user, bulk actions should be based off hosts instead of content hosts (2) |
||
82 | * 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 (2) |
||
83 | * 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 (2) |
||
84 | 1 | 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 (2) |
85 | 3 | 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 (2) |
86 | * 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) |
||
87 | 5 | Justin Sherrill | * As a user, i expect package profile uploading to continue to work under the unified model (2) |
88 | 3 | Justin Sherrill | * As a user, i expect client actions (errata install, package install, etc..) to continue to work under the unified model (3) |
89 | * As a user, i expect the subscription and content aspects of hosts to be identified by their host id, not a uuid (3) |
||
90 | * As a user, i expect to be able to find the uuid of a host with subscriptions within the UI/hammer (1) |
||
91 | * As a user, i expect to be able to search hosts by applicable errata (.5) |
||
92 | * As a user, i expect to be able to search hosts by installed package (.5) |
||
93 | 1 | Justin Sherrill | * As a user, i expect to be able to search hosts by subscription facts (.5) |
94 | 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) |
95 | |||
96 | H2. User Stories (P2) |
||
97 | |||
98 | * As a user, i expect an api for interacting with content and subscription aspects of hosts (6) |
||
99 | 5 | 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) |
100 | 3 | Justin Sherrill | * As a user, i expect the following hammer commands to be migrated: |
101 | > * hammer content-host errata apply -> hammer host content errata apply (.5) |
||
102 | > * hammer content-host errata info -> hammer host content errata info (.5) |
||
103 | > * hammer content-host errata list -> hammer host content errata list (.5) |
||
104 | > * hammer content-host package install -> hammer host content package install (.5) |
||
105 | > * hammer content-host package remove -> hammer host content package remove (.5) |
||
106 | > * hammer content-host package upgrade -> hammer host content package upgrade (.5) |
||
107 | > * hammer content-host package upgrade-all -> hammer host content package upgrade-all (.5) |
||
108 | 1 | Justin Sherrill | > * hammer content-host package-group install -> hammer host content package-group install (.5) |
109 | > * hammer content-host package-group remove -> hammer host content package-group remove (.5) |
||
110 | > * hammer content-host update -> hammer host content update (for updating content view, lifecycle environment) (.5) |
||
111 | > * hammer content-host update -> hammer host subscription update (for updating service-level, release-version) (.5) |
||
112 | > * hammer host puppet-classes (.5) |
||
113 | 3 | Justin Sherrill | > * hammer host puppetrun (.5) |
114 | 5 | Justin Sherrill | |
115 | |||
116 | H2 User Stories (P3) |
||
117 | * As a developer, I want to pull in subscriptions and related hosts into the database (7) |
||
118 | * As a user, I expect to search for hosts by their subscriptions (.5) |