Diagram: PXE-based provisioning with Discovery and Katello plugins

Hello,

I've created sequence diagram of Foreman provisioning with Discovery and
Katello plugins:

https://github.com/theforeman/theforeman.org/pull/333/files

I would like you to review it. My goal is to create similar diagrams on
virtualization and then image-based deployment as well. This one looks
like the most complex one, so send your comments first.

··· -- Later, Lukas #lzap Zapletal

It looks pretty good to me. Minor comments follow:

  • The comment 'can be automated via auto-provisioning' is a bit
    unclear, I'm afraid "auto-provisioning" is not a known term for new
    users.
  • It'd be nice to see how it is without Pulp & Candlepin (not all
    users will use subscription-manager nor Katello)
  • After arrow 26 and 27, there's no arrow coming from the Puppet
    master to Foreman to submit the report & facts?
  • Maybe you want to highlight manual processes in a different color
    or something. As I look into these diagrams, I keep on thinking 'which
    steps are actually automated'? I think it's just step 1 and 6 that are
    manual, but it's not very clear.

The current docs lack this kind of comprehensive look into what's
really Foreman doing. Are the next diagrams also going to include
discovery? I like it, but maybe we want to remove it for the general
Foreman manual?

Thank you so much, this effort is REALLY appreciated! Looking forward
for more :slight_smile:

··· On Thu, Feb 26, 2015 at 3:36 PM, Lukas Zapletal wrote: > Hello, > > I've created sequence diagram of Foreman provisioning with Discovery and > Katello plugins: > > https://github.com/theforeman/theforeman.org/pull/333/files > > I would like you to review it. My goal is to create similar diagrams on > virtualization and then image-based deployment as well. This one looks > like the most complex one, so send your comments first. > > -- > Later, > Lukas #lzap Zapletal > > -- > You received this message because you are subscribed to the Google Groups "foreman-dev" group. > To unsubscribe from this group and stop receiving emails from it, send an email to foreman-dev+unsubscribe@googlegroups.com. > For more options, visit https://groups.google.com/d/optout.


Daniel Lobato

@elobatoss
blog.daniellobato.me
daniellobato.me

GPG: http://keys.gnupg.net/pks/lookup?op=get&search=0x7A92D6DD38D6DE30

> - The comment 'can be automated via auto-provisioning' is a bit
> unclear, I'm afraid "auto-provisioning" is not a known term for new
> users.

Yes, this one is the most complex one. I will create more, without
discovery, katello and stuff (so no auto-provisioning).

> - It'd be nice to see how it is without Pulp & Candlepin (not all
> users will use subscription-manager nor Katello)

Ditto

> - After arrow 26 and 27, there's no arrow coming from the Puppet
> master to Foreman to submit the report & facts?

Added

> The current docs lack this kind of comprehensive look into what's
> really Foreman doing. Are the next diagrams also going to include
> discovery? I like it, but maybe we want to remove it for the general
> Foreman manual?

That's what I am actually going to do now.

> Thank you so much, this effort is REALLY appreciated! Looking forward
> for more :slight_smile:

See the same PR with the fix and simplified version including image and
cloud based variations.

Please carefully review and give it thumbs up. Comments preferably on
github.com.

Thanks.

··· -- Later, Lukas #lzap Zapletal

Note that another diagram was added recently for the basic network
provisioning case onto a compute resource, we should try to unify it a
little or make it clear what the differences are (and not just different
graphics tools).

I wrote up a small list of steps next to it in the manual, section 4.4.6.

··· On 03/03/15 16:32, Lukas Zapletal wrote: >> > The current docs lack this kind of comprehensive look into what's >> > really Foreman doing. Are the next diagrams also going to include >> > discovery? I like it, but maybe we want to remove it for the general >> > Foreman manual? > That's what I am actually going to do now.


Dominic Cleal
Red Hat Engineering

> Note that another diagram was added recently for the basic network
> provisioning case onto a compute resource, we should try to unify it a
> little or make it clear what the differences are (and not just different
> graphics tools).
>
> I wrote up a small list of steps next to it in the manual, section 4.4.6.

I saw it and my goal is to put these next to your use case.

Not sure what you mean by making it clear. You want me to write a text
describing what actually happens?

··· -- Later, Lukas #lzap Zapletal

I don't think that's as necessary in your diagrams, they contain much
more information than the existing one.

By making it clear, I mean make it clear what's different in each
scenario, e.g. the first is bare metal + PXE, the second adds a PXE
based compute resource, the third is an image compute resource. Try not
to duplicate the diagram that's already there so users don't get
confused, ensure it's distinct.

··· On 04/03/15 16:16, Lukas Zapletal wrote: >> Note that another diagram was added recently for the basic network >> provisioning case onto a compute resource, we should try to unify it a >> little or make it clear what the differences are (and not just different >> graphics tools). >> >> I wrote up a small list of steps next to it in the manual, section 4.4.6. > > I saw it and my goal is to put these next to your use case. > > Not sure what you mean by making it clear. You want me to write a text > describing what actually happens?


Dominic Cleal
Red Hat Engineering

FYI I created these diagrams for downstream docs, I wanted cover
everything.

Since those are "use cases", I thought duplicity won't hurt.

LZ

··· On Thu, Mar 05, 2015 at 08:11:34AM +0000, Dominic Cleal wrote: > On 04/03/15 16:16, Lukas Zapletal wrote: > >> Note that another diagram was added recently for the basic network > >> provisioning case onto a compute resource, we should try to unify it a > >> little or make it clear what the differences are (and not just different > >> graphics tools). > >> > >> I wrote up a small list of steps next to it in the manual, section 4.4.6. > > > > I saw it and my goal is to put these next to your use case. > > > > Not sure what you mean by making it clear. You want me to write a text > > describing what actually happens? > > I don't think that's as necessary in your diagrams, they contain much > more information than the existing one. > > By making it clear, I mean make it clear what's different in each > scenario, e.g. the first is bare metal + PXE, the second adds a PXE > based compute resource, the third is an image compute resource. Try not > to duplicate the diagram that's already there so users don't get > confused, ensure it's distinct. > > -- > Dominic Cleal > Red Hat Engineering > > -- > You received this message because you are subscribed to the Google Groups "foreman-dev" group. > To unsubscribe from this group and stop receiving emails from it, send an email to foreman-dev+unsubscribe@googlegroups.com. > For more options, visit https://groups.google.com/d/optout.


Later,
Lukas #lzap Zapletal