[Starlingx-discuss] StarlingX Apps general documentation
To all app developers out there, The only Developer refence so far is https://wiki.openstack.org/wiki/StarlingX/Containers/HowToAddNewFluxCDAppInS..., which focuses on building a StarlingX App which uses FluxCD. The focus is more on build environment so the interaction with the App Framework itself was out of scope. In an attempt demystify the StarlingX App <-> App Framework interaction I started a new page: https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals . It is in no way complete work, the work is just at the beginning. The purpose would be to show examples on how to configure your app to have different behavior, explain what these behaviors are, list scenarios, general guidelines. The only scenarios explained so far are: * auto update of apps * keep/reset user overrides during updates * keep/reset disabled helm charts during updates I believe we can enable auto update functionality for the apps, the only reason I sent an email so early is out of curiosity, want the app devs to be aware of the auto-update scenario and then get feedback from app devs about their app specific requirements preventing automatic update from being enabled (if any). Also, will let you know when more info is added to the wiki. Thanks, Dan Voiculeasa
An update on this: I've added information about how to upgrade apps during platform upgrades in: https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals#... Fixed the incorrect information in upgrades/auto_update section, the metadata here is used after, not during platform upgrades. https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals#... Mentioned the existence of behavior/platform_managed_apps metadata, full details in progress. Thanks, Dan Voiculeasa ________________________________ From: Voiculeasa, Dan Sent: Tuesday, February 7, 2023 5:01 PM To: starlingx-discuss <starlingx-discuss@lists.starlingx.io> Subject: StarlingX Apps general documentation To all app developers out there, The only Developer refence so far is https://wiki.openstack.org/wiki/StarlingX/Containers/HowToAddNewFluxCDAppInS..., which focuses on building a StarlingX App which uses FluxCD. The focus is more on build environment so the interaction with the App Framework itself was out of scope. In an attempt demystify the StarlingX App <-> App Framework interaction I started a new page: https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals . It is in no way complete work, the work is just at the beginning. The purpose would be to show examples on how to configure your app to have different behavior, explain what these behaviors are, list scenarios, general guidelines. The only scenarios explained so far are: * auto update of apps * keep/reset user overrides during updates * keep/reset disabled helm charts during updates I believe we can enable auto update functionality for the apps, the only reason I sent an email so early is out of curiosity, want the app devs to be aware of the auto-update scenario and then get feedback from app devs about their app specific requirements preventing automatic update from being enabled (if any). Also, will let you know when more info is added to the wiki. Thanks, Dan Voiculeasa
Thanks, Dan Voiculeasa ________________________________ From: Voiculeasa, Dan <Dan.Voiculeasa@windriver.com> Sent: Friday, March 3, 2023 7:31 PM To: starlingx-discuss <starlingx-discuss@lists.starlingx.io> Subject: Re: StarlingX Apps general documentation An update on this: I've added information about how to upgrade apps during platform upgrades in: https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals#... Fixed the incorrect information in upgrades/auto_update section, the metadata here is used after, not during platform upgrades. https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals#... Mentioned the existence of behavior/platform_managed_apps metadata, full details in progress. Thanks, Dan Voiculeasa ________________________________ From: Voiculeasa, Dan Sent: Tuesday, February 7, 2023 5:01 PM To: starlingx-discuss <starlingx-discuss@lists.starlingx.io> Subject: StarlingX Apps general documentation To all app developers out there, The only Developer refence so far is https://wiki.openstack.org/wiki/StarlingX/Containers/HowToAddNewFluxCDAppInS..., which focuses on building a StarlingX App which uses FluxCD. The focus is more on build environment so the interaction with the App Framework itself was out of scope. In an attempt demystify the StarlingX App <-> App Framework interaction I started a new page: https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals . It is in no way complete work, the work is just at the beginning. The purpose would be to show examples on how to configure your app to have different behavior, explain what these behaviors are, list scenarios, general guidelines. The only scenarios explained so far are: * auto update of apps * keep/reset user overrides during updates * keep/reset disabled helm charts during updates I believe we can enable auto update functionality for the apps, the only reason I sent an email so early is out of curiosity, want the app devs to be aware of the auto-update scenario and then get feedback from app devs about their app specific requirements preventing automatic update from being enabled (if any). Also, will let you know when more info is added to the wiki. Thanks, Dan Voiculeasa
Another update on this: After more experiments it was discovered we have the ability to automatically down-version in some cases. The auto-update procedure is explained with more details about automatic up-version/down-version in case of patch apply/remove. https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals#... Controlling the behavior to allow an application to be automatically uploaded or applied after first controller unlock is described here: https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals#... Thanks, Dan Voiculeasa ________________________________ From: Voiculeasa, Dan <Dan.Voiculeasa@windriver.com> Sent: Friday, March 3, 2023 7:31 PM To: starlingx-discuss <starlingx-discuss@lists.starlingx.io> Subject: Re: StarlingX Apps general documentation An update on this: I've added information about how to upgrade apps during platform upgrades in: https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals#... Fixed the incorrect information in upgrades/auto_update section, the metadata here is used after, not during platform upgrades. https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals#... Mentioned the existence of behavior/platform_managed_apps metadata, full details in progress. Thanks, Dan Voiculeasa ________________________________ From: Voiculeasa, Dan Sent: Tuesday, February 7, 2023 5:01 PM To: starlingx-discuss <starlingx-discuss@lists.starlingx.io> Subject: StarlingX Apps general documentation To all app developers out there, The only Developer refence so far is https://wiki.openstack.org/wiki/StarlingX/Containers/HowToAddNewFluxCDAppInS..., which focuses on building a StarlingX App which uses FluxCD. The focus is more on build environment so the interaction with the App Framework itself was out of scope. In an attempt demystify the StarlingX App <-> App Framework interaction I started a new page: https://wiki.openstack.org/wiki/StarlingX/Containers/StarlingXAppsInternals . It is in no way complete work, the work is just at the beginning. The purpose would be to show examples on how to configure your app to have different behavior, explain what these behaviors are, list scenarios, general guidelines. The only scenarios explained so far are: * auto update of apps * keep/reset user overrides during updates * keep/reset disabled helm charts during updates I believe we can enable auto update functionality for the apps, the only reason I sent an email so early is out of curiosity, want the app devs to be aware of the auto-update scenario and then get feedback from app devs about their app specific requirements preventing automatic update from being enabled (if any). Also, will let you know when more info is added to the wiki. Thanks, Dan Voiculeasa
participants (1)
-
Voiculeasa, Dan