stratos-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Shavindri Dissanayake <shavin...@wso2.com>
Subject Re: [Docs] Verifying the steps of a Cartridge Agent Life Cycle
Date Thu, 07 May 2015 05:22:30 GMT
Hi Chamila,

Thank you for the quick feedback! I worked on the changes as mentioned.

I do agree with you on how the content was presented previously. Therefore
removed the tabular view and put it in a single, scrollable flow but under
different topics (the states of the CA life cycle). Hope this is fine with
you ?
(My initial thought here was to present the content in a organised manner
so the user will not be overwhelmed by the amount of content shown at once.
As they might not go through the content in such cases but from a
developers perspective as you mentioned they would like to see all the info
at once.)

Thanks & Regards
Shavindri Dissanayake
Technical Writer
LinkedIn Profile
<https://www.linkedin.com/profile/view?id=112227277&trk=nav_responsive_tab_profile>
Mob: 0779966739

WSO2 Inc.
lean.enterprise.middleware

On Wed, May 6, 2015 at 11:55 PM, Chamila De Alwis <chamilad@wso2.com> wrote:

> Hi Shavindri,
>
>    - Minor typo in the first paragraph, "what is does" should be "what it
>    does".
>    - Start stage, IMO going in to active state should be based on two
>    types of Cartridges when it comes repository details. The instances of
>    Cartridge types which have repositories to be cloned go through the
>    instance activation after cloning the provided repository. The ones that do
>    not publish the activate event immediately. In the earlier releases, AFAIR,
>    these two types were distinguishable by the Cartridge provider field
>    ('data' or not), however in 4.1.0 I think any cartridge can have repository
>    information. Therefore, these are not two "methods" per se. So a more
>    correct description would go along something as follows.
>       - After publishing InstanceStartedEvent the Cartridge Agent will
>       check if any repository details are provided.
>       - Repository details not provided
>          - The CA will immediately publish InstanceActivatedEvent after
>          checking if the service ports are active. It does not have to interact with
>          any artifact repositories.
>       - Repository details provided
>          - The CA will continue execution without publishing
>          InstanceActivatedEvent. If any repositories are provided, Stratos Manager
>          will pick up those details and publish ArtifactUpdatedEvent, which the CA
>          will listen to. After receiving the ArtifactUpdatedEvent the CA will clone
>          the repository and publish InstanceActivatedEvent after checking if service
>          ports are active. This is executed in the event listening thread.
>       - "Next it will check if the log publisher of the instance is
>    enabled." should be "Next if log publishing is enabled in the instance it
>    will start the log publisher process"
>    - I think the description in the CA termination in Active stage
>    section can be changed to something like the following.
>       - The instance termination can be result of several actions
>          - Application undeployment
>          - Termination of a dependent instance with a relationship of
>          "terminate-dependents"
>          - Termination of an instance with the relationship of
>          "terminate-all"
>       - Any of the above executions result in the instance being moved to
>       Pending Termination state.
>    - "The agent will then publish the InstanceCleanupEvent in the
>    autoscaler and notify the instance." should be "Upon receiving
>    InstanceCleanupMemberEvent or InstanceCleanupClusterEvent, the CA will
>    publish InstanceMaintenanceModeEvent, clean the instance and publish
>    InstanceReadyToShutdownEvent. The Autoscaler, upon receiving
>    MemberReadyToShutdownEvent will add the particular instance to a
>    termination queue, which will ultimately result in the instance being
>    terminated in the IaaS."
>
> Furthermore (and I'm not sure if I've missed this discussion earlier, if I
> did sorry for being a late comer to the discussion), I'm not sure if tabbed
> approach would be the best to describe a series of events which are not
> separate from each other or are not replaceable by each other. The reader
> expects a flow of events, which IMO should be described as it is, in a
> single, scrollable flow. A tabbed UI usually indicates that there are
> alternatives [1], or completely different set of options, in contrast to a
> well connected, well flowing series of actions. I've seen the same pattern
> used elsewhere in the new documentation, which IMO is a UI anti-pattern.
> WDYT?
>
>
> [1] - https://msdn.microsoft.com/en-us/library/6ka1wd3w(v=vs.110).aspx -
> Please check how tabs are used to indicate how the same function can be
> achieved by C# and VB .Net codes.
>
>
> Regards,
> Chamila de Alwis
> Software Engineer | WSO2 | +94772207163
> Blog: code.chamiladealwis.com
>
>
>
> On Wed, May 6, 2015 at 11:17 PM, Shavindri Dissanayake <shavindri@wso2.com
> > wrote:
>
>> Hi Devs,
>>
>> I have documented the steps of a Cartridge Agent Life Cycle [1], as per
>> the feedback and diagram given by Chamila.
>>
>> Would you please be able to go though the content and share your feedback
>> please, on areas where content could be improved further.
>>
>> [1]
>> https://cwiki.apache.org/confluence/display/STRATOS/4.1.0+Cartridge+Agent+Lifecycle
>>
>> Thanks & Regards
>> Shavindri Dissanayake
>> Technical Writer
>> LinkedIn Profile
>> <https://www.linkedin.com/profile/view?id=112227277&trk=nav_responsive_tab_profile>
>> Mob: 0779966739
>>
>> WSO2 Inc.
>> lean.enterprise.middleware
>>
>
>

Mime
View raw message