Difference between revisions of "StarlingX"

Latest revision as of 15:02, 3 January 2024

Welcome!

Welcome to the StarlingX Contributor Community! We're glad you are here. Everything you need to get started with StarlingX is available below. If you have questions or need advice, please reach out to us on the starlingx-discuss mailing list or IRC - we're here to help!

Getting Started

Culture

Communicate

Developer Resources

User resources

Code

Governance

Meetups & PTGs

Planning & Processes

Useful queries

StarlingX sub-projects

Special Interest Groups (SIGs)

The previous wiki home page can be found here

@@ Line 1: / Line 1: @@
 __NOTOC__
-[[File:Starlingx-logo-300w.png|center]]
+<center>
+== Welcome! ==
+Welcome to the StarlingX Contributor Community!  We're glad you are here.  Everything you need to get started with StarlingX is available below.  If you have questions or need advice, please reach out to us on the starlingx-discuss mailing list or IRC - we're here to help!
+</center>
+----
+<!-- the rest of the page is a series of four-column tables -->
 {| style="border-collapse: separate; border-spacing: 25px;"
-| style="vertical-align:top; width:50%;" |
+|style="vertical-align:top; width:25%;" |
-== Welcome to the StarlingX project!!! ==
+<!-- 1st table 1st column contents -->
+===== Getting Started =====
+----
+* [[StarlingX/Releases|Releases]]
+* [https://www.starlingx.io/ StarlingX web site]
+* [https://docs.starlingx.io/ Documentation]
+* [https://www.starlingx.io/learn/ Learn more]
+|style="vertical-align:top; width:25%;" |
+<!-- 1st table 2nd column contents -->
+===== Culture =====
+----
+* [https://www.openstack.org/legal/community-code-of-conduct/ Code of Conduct]
+* [https://governance.openstack.org/tc/reference/opens.html The Four Opens]
-StarlingX is a fully featured and high performance Edge Cloud software stack that is based on [https://www.windriver.com/products/titanium-cloud/ Wind River® Titanium Cloud] R5 product.   Intel and Wind River have jointly open sourced this software and we invite you to download, build, install and run it.
+|style="vertical-align:top; width:25%;" |
+<!-- 1st table 3rd column contents -->
+===== Communicate =====
+----
+* [http://lists.starlingx.io/ Email lists]
+* IRC: #starlingX@oftc
+* [https://docs.openstack.org/infra/manual/developers.html IRC setup]
+* [[Starlingx/Meetings|Weekly calls schedule]]
+* [https://zoom.us/j/342730236 Weekly calls Zoom]
+*[https://etherpad.opendev.org/p/stx-status Community Meeting etherpad]
+*[https://etherpad.opendev.org/p/stx-cores TSC etherpad]
+|style="vertical-align:top; width:25%;" |
+<!-- 1st table 4th column contents -->
+===== Developer Resources =====
+----
+* [https://docs.openstack.org/infra/manual/developers.html Openstack Developer Guide]
+* [https://drive.google.com/drive/folders/1AvUCq3ojuhNZV6XE8YdRhp9PVxixRIeE Detailed Training Materials]
+* [[StarlingX/StarlingX VirtualBox Configuration Guide | VirtualBox Guide]]
+* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com  iPXE]]
+* [[StarlingX/StarlingX Debian Information Guide | Debian Information Guide]]
+* [[StarlingX/StarlingX Debian on ARM Information Guide | Debian on ARM Information Guide (WIP)]]
+* [https://docs.starlingx.io/developer_resources/code-submission-guide.html Code Submission Guidelines]
+* [https://docs.starlingx.io/contributor/index.html Contribution guidelines]
+* [https://docs.starlingx.io/contributor/api_contribute_guide.html StarlingX API Contributor Guide]
+* [https://drive.google.com/drive/folders/1AvUCq3ojuhNZV6XE8YdRhp9PVxixRIeE StarlingX Reference Material]
+* [https://wiki.openstack.org/wiki/StarlingX/Defect_Handling_Process#Key_StarlingX_Bug_Queries StarlingX Bug Queries]
+|}
+{| style="border-collapse: separate; border-spacing: 25px;"
+|style="vertical-align:top; width:25%;" |
+<!-- 2nd table 1st column contents -->
-components from the [https://www.windriver.com/products/titanium-cloud/ Wind River® Titanium Cloud] portfolio, and are using this code as the seed to deliver the StarlingX open source Edge Computing Stack.   Wind River Titanium Cloud was built on open source components, which were then extended and targeted to be hardened to address critical infrastructure requirements: high availability, fault management, and performance management needed for continuous 24/7 operation.
+===== User resources  =====
+----
+* [https://docs.starlingx.io/deploy_install_guides/index-install-e083ca818006.html Installation and Deployment Guides]
+* [[StarlingX/Platform Features|Hardware platform features]]
+* [https://docs.openstack.org/infra/manual/developers.html OpenStack Developer's Guide]
+* [https://docs.openstack.org/infra/manual/creators.html OpenStack Project Creator's Guide]
+* [https://wiki.openstack.org/wiki/How_To_Contribute OpenStack Contributors Guide]
+* [https://governance.openstack.org/tc/reference/project-testing-interface.html OpenStack Project Testing Interface]
+* [https://wiki.openstack.org/wiki/StarlingX/Tips_Tricks_Debugging_Techniques Tips, Tricks and Debugging Techniques]
+* [https://wiki.openstack.org/wiki/StarlingX/Features_Around_Kubernetes Features Around STX Kubernetes ]
-The StarlingX project opens all of these enhancements to the open source community.  We invite the community to contribute to the project and help us define, a the infrastructure stack for Edge Computing.
-| style="vertical-align:top; width:50%;" | The code made available via the StarlingX project will:
-* Provide service management, REST APIs, and process monitoring
-* Deliver standalone fault management service, including extensions to OpenStack Horizon
-* Provide software repository management, patching, upgrade, backup, and restore services
-* Include bare metal management, a next-generation Virtual Infrastructure Manager (VIM) along with VIM helper components, the OpenStack Nova API proxy, and guest API infrastructure
+|style="vertical-align:top; width:25%;" |
+<!-- 2nd table 2nd column contents -->
-Additional code contributions not upstreamed to existing projects will deliver capabilities through sub-projects under StarlingX, to provide critical functionality: service management, fault management, software and lifecycle management, bare metal installation and management, and configuration management.
+===== Code =====
-|}
 ----
-{| style="border-collapse: separate; border-spacing: 25px;"
+* [https://opendev.org/starlingx Source code repositories]
-|style="vertical-align:top; width:50%;" |
+* [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]
-== Documentation ==
+* [https://starlingx.biterg.io Bitergia Code Stats]
-* Under development
+|style="vertical-align:top; width:25%;" |
+<!-- 2nd table 3rd column contents -->
-== Code ==
+===== Governance =====
+----
+* [https://docs.starlingx.io/governance/index.html Governance documents]
+* [https://docs.starlingx.io/election/ Election documents and results]
+* [https://etherpad.openstack.org/p/stx-governance Archive: Draft governance etherpad]
+* [[Starlingx/Initial Governance|Archive: Draft governance wiki]]
+|style="vertical-align:top; width:25%;" |
+<!-- 2nd table 4th column contents -->
+===== Meetups & PTGs =====
+----
+* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
+* [https://etherpad.openstack.org/p/stx-chandler-meetup Jan 2019 meetup etherpad]
+* [https://www.starlingx.io/blog/starlingx-meetup-january-2019.html Jan 2019 meetup blog]
+* [https://etherpad.openstack.org/p/stx-ptg-agenda StarlingX Denver 2019 PTG Agenda and Notes]
+* [https://etherpad.openstack.org/p/starlingX-winter-2020-meetup March 2020 meetup etherpad]
+* [https://etherpad.opendev.org/p/stx-virtual-PTG-June June 2020 PTG etherpad]
+* [https://etherpad.opendev.org/p/stx-ptg-planning-october-2020 October 2020 PTG etherpad]
+* [https://etherpad.opendev.org/p/stx-ptg-planning-april-2021 April 2021 PTG etherpad]
+* [https://etherpad.opendev.org/p/stx-ptg-planning-october-2021 October 2021 PTG etherpad]
+|}
+<!-- the rest of the page is a series of four-column tables -->
+{| style="border-collapse: separate; border-spacing: 25px;"
+|style="vertical-align:top; width:25%;" |
+<!-- 3rd table 1st column contents -->
-* [https://git.openstack.org/cgit/openstack/stx Gerrit repositories]
+===== Planning & Processes =====
-** Instructions for how to download and build the code are in progress
+----
-* [https://review.openstack.org/ Gerrit Web UI]
+* [[StarlingX/Release_Plan|StarlingX Release Planning]]
-* [https://review.openstack.org/#/admin/projects/?filter=stx StarlingX Gerrit Projects]]
+* [https://docs.starlingx.io/contributor/development_process.html Development Process]
-** Hint for fast review of open reviews related to STX, in search box use the regular expression "status:open AND project:^openstack/stx-@"
+* [[StarlingX/Tags and Prefixes|Tags and Prefixes]]
-* [https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fstx%2Dclients+OR+project%3Aopenstack%2Fstx%2Dconfig+OR+project%3Aopenstack%2Fstx%2Dfault+OR+project%3Aopenstack%2Fstx%2Dgplv2+OR+project%3Aopenstack%2Fstx%2Dgplv3+OR+project%3Aopenstack%2Fstx%2Dgui+OR+project%3Aopenstack%2Fstx%2Dha+OR+project%3Aopenstack%2Fstx%2Dinteg+OR+project%3Aopenstack%2Fstx%2Dmanifest+OR+project%3Aopenstack%2Fstx%2Dmetal+OR+project%3Aopenstack%2Fstx%2Dnfv+OR+project%3Aopenstack%2Fstx%2Droot+OR+project%3Aopenstack%2Fstx%2Dtis%2Drepo+OR+project%3Aopenstack%2Fstx%2Dtools+OR+project%3Aopenstack%2Fstx%2Dupdate+OR+project%3Aopenstack%2Fstx%2Dupstream+OR+project%3Aopenstack%2Fstx%2Dutils%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%2D1+label%3AVerified%3E%3D1%2Czuul+NOT+reviewedby%3Aself&title=StarlingX+Review+Inbox&Needs+final+%2B2=label%3ACode%2DReview%3E%3D2+limit%3A50+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself&Passed+Zuul%2C+No+Negative+Feedback+%28Small+Fixes%29=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cstarlingx%2Dcore+delta%3A%3C%3D10&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cstarlingx%2Dcore+delta%3A%3E10&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%2DReview%3C%3D%2D1+NOT+label%3ACode%2DReview%3E%3D1+age%3A5d&You+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself+NOT+label%3ACode%2DReview%3E%3D1%2Cself+reviewer%3Aself&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+is%3Areviewed+age%3A2d StarlingX Gerrit Review Dashboard]
+* [https://storyboard.openstack.org/#!/project_group/86 Storyboard Group]
-** Also in [http://paste.openstack.org/show/723397/ StarlingX Gerrit Review Dashboard]  (copy the URL from there into a browser bookmark)
+|style="vertical-align:top; width:25%;" |
+<!-- 3rd table 2nd column contents -->
-== Bug Tracking ==
+===== Useful queries =====
+----
+* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86 All active stories]
+* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.4.0 All active stories for StarlingX 4.0]
+* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.4.0 All open bugs for StarlingX 4.0].
+* [https://review.opendev.org/dashboard/?title=StarlingX+Review+Inbox&foreach=%28%0Aprojects%3Astarlingx%29%0Astatus%3Aopen%0ANOT+owner%3Aself%0ANOT+label%3AWorkflow%3C%3D%2D1%0Alabel%3AVerified%3E%3D1%2Czuul%0ANOT+reviewedby%3Aself&Needs+final+%2B2=label%3ACode%2DReview%3E%3D2+limit%3A50+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself&Passed+Zuul%2C+No+Negative+Feedback+%28Small+Fixes%29=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cstarlingx%2Dcore+delta%3A%3C%3D10&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cstarlingx%2Dcore+delta%3A%3E10&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%2DReview%3C%3D%2D1+NOT+label%3ACode%2DReview%3E%3D1+age%3A5d&You+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself+NOT+label%3ACode%2DReview%3E%3D1%2Cself+reviewer%3Aself&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+is%3Areviewed+age%3A2d Gerrit Review Dashboard]
+* [https://review.opendev.org/#/dashboard/?title=StarlingX+TSC+Overview&foreach=%28%0Aproject%3Astarlingx%2Fgovernance+OR%0Aproject%3Astarlingx%2Fspecs%0A%29%0Astatus%3Aopen%0ANOT+label%3AWorkflow%3C%3D%2D1%0Alabel%3AVerified%3E%3D1%2Czuul%0ANOT+reviewedby%3Aself&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%2DReview%3C%3D%2D1+NOT+label%3ACode%2DReview%3E%3D1+age%3A5d+branch%3Amaster&You+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself+NOT+label%3ACode%2DReview%3E%3D1%2Cself+reviewer%3Aself&Needs+final+%2B2=label%3ACode%2DReview%3E%3D2+limit%3A50+NOT+reviewedby%3Aself+NOT+label%3Aworkflow%3E%3D1&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1+limit%3A50+branch%3Amaster&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2+days%29=NOT+label%3ACode%2DReview%3C%3D%2D1+NOT+label%3ACode%2DReview%3E%3D1+age%3A2d+branch%3Amaster TSC Review Dashboard]
-* [https://storyboard.openstack.org/#!/worklist/354 StarlingX Bug List]
+|style="vertical-align:top; width:25%;" |
-** This list is sorted manually by drag and drop.
+<!-- 3rd table 3rd column contents -->
-** Please create bugs for any issues found in Storyboard, against one of the stx-* projects.  If you can't find the right project, use stx-integ
-** After you create the bug, please add it to the Bug Worklist (link above)
-|style="vertical-align:top; width:50%;" |
+===== StarlingX sub-projects =====
-== Status and Planning ==
+----
+* [[StarlingX/Build|Build project]]
+* [[StarlingX/Containers|Containers project]]
+* [[StarlingX/DistCloud|Distributed Cloud project]]
+* [[StarlingX/Distro|Distro - OS project]]
+* [[StarlingX/DistroOpenStack|Distro - OpenStack project]]
+* [[StarlingX/Docs_and_Infra|Docs and Infra project]]
+* [[StarlingX/FlockServices|Flock Services project]]
+* [[StarlingX/MultiOS|MultiOS project (w/ Distro-OS)]]
+* [[StarlingX/Networking|Networking project]]
+* [[StarlingX/Security|Security project]]
+* [[StarlingX/Releases|Releases project]]
+* [[StarlingX/Test|Test project]]
+* [[StarlingX/Devstack|Devstack Integration (Inactive)]]
+* [[StarlingX/Python2|Python2 to Python3 Transition (Inactive)]]
+* [[StarlingX/stxinabox|StarlingX In-a-box (Inactive)]]
+* [[StarlingX/Zull|Zuul Enablement and Coverage (Inactive)]]
+* [[StarlingX/Distro/tpm-verify|tpm-verify (Inactive)]]
-* [https://etherpad.openstack.org/p/stx-status Status Meeting Notes]
-* [https://storyboard.openstack.org/#!/project_group/86 StarlingX Storyboards]]
-* [https://etherpad.openstack.org/p/stx-planning StarlingX Planning] (contains sub-projects and Worklists)
-== References ==
+|style="vertical-align:top; width:25%;" |
+<!-- 1st table 4th column contents -->
-* [https://etherpad.openstack.org/p/stx-notes The list of repos] and other things
+===== Special Interest Groups (SIGs) =====
+----
+* [[StarlingX/Packet SIG|Packet SIG]]
+* [[StarlingX/First Contact SIG|First Contact SIG]]
+|}
-== OpenStack Documentation ==
+The previous wiki home page can be found [[StarlingX/Archived wiki home page|here]]
-These are references to general OpenStack material:
-* [https://docs.openstack.org/infra/manual/developers.html Developer's Guide]
-* [https://docs.openstack.org/infra/manual/creators.html Project Creator's Guide]
-* [https://wiki.openstack.org/wiki/How_To_Contribute The Contributors Guide]   (the older wiki page)
-* [https://governance.openstack.org/tc/reference/project-testing-interface.html Project Testing Interface]
-|}