Jump to: navigation, search

Difference between revisions of "StarlingX"

(→‎Story Tracking)
(→‎Useful queries)
 
(188 intermediate revisions by 26 users not shown)
Line 2: Line 2:
 
<center>
 
<center>
  
−
== Welcome to the StarlingX Project ==
+
== 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>
 
</center>
−
StarlingX is a fully featured and high performance Edge Cloud software stack that is based on the [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. 
+
----
  
−
Wind River Titanium Cloud was originally built on open source components, that were then extended and hardened to meet critical infrastructure requirements, including: high availability, fault management, and performance management. This software provides numerous features and capabilities to enable 24/7 operation of mission critical applications.
+
<!-- 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%;" |
 +
<!-- 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]
  
−
The StarlingX project opens all of these enhancements to the open source community.  Please join us as we build the infrastructure stack for Edge Computing.
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 2nd column contents -->
 +
===== Culture =====
 
----
 
----
−
<!-- the rest of the page is a two-column table -->
+
* [https://www.openstack.org/legal/community-code-of-conduct/ Code of Conduct]
−
{| style="border-collapse: separate; border-spacing: 25px;"
+
* [https://governance.openstack.org/tc/reference/opens.html The Four Opens]
−
|style="vertical-align:top; width:50%;" |
 
−
<!-- left column contents -->
 
−
== Documentation ==
 
  
−
These three documents will help get you started building, installing, and validating your installation of StarlingX:
+
|style="vertical-align:top; width:25%;" |
−
* [[StarlingX/Developer Guide|Developer Guide]]
+
<!-- 1st table 3rd column contents -->
−
* [[StarlingX/Installation Guide|Installation Guide]]
+
===== Communicate =====
−
* [[StarlingX/Validation Guide|Validation Guide]]
+
----
 +
* [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 -->
  
−
== Code ==
+
===== Developer Resources =====
−
The StarlingX project uses Gerrit as its web-based code change management and review tool.
+
----
−
* [https://git.openstack.org/cgit/openstack/stx Gerrit repositories] maintain the StarlingX code, build instructions are in the [[StarlingX/Developer Guide]]
+
* [https://docs.openstack.org/infra/manual/developers.html Openstack Developer Guide]
−
* [https://review.openstack.org/#/admin/projects/?filter=stx StarlingX Gerrit Projects] and [https://review.openstack.org/#/q/status:open+AND+project:%255Eopenstack/stx-%2540 Open StarlingX project reviews]
+
* [https://drive.google.com/drive/folders/1AvUCq3ojuhNZV6XE8YdRhp9PVxixRIeE Detailed Training Materials]
−
* [https://review.openstack.org/#/dashboard/?foreach=(project:openstack/stx-clients%20OR%20project:openstack/stx-config%20OR%20project:openstack/stx-fault%20OR%20project:openstack/stx-gplv2%20OR%20project:openstack/stx-gplv3%20OR%20project:openstack/stx-gui%20OR%20project:openstack/stx-ha%20OR%20project:openstack/stx-integ%20OR%20project:openstack/stx-manifest%20OR%20project:openstack/stx-metal%20OR%20project:openstack/stx-nfv%20OR%20project:openstack/stx-root%20OR%20project:openstack/stx-tis-repo%20OR%20project:openstack/stx-tools%20OR%20project:openstack/stx-update%20OR%20project:openstack/stx-upstream%20OR%20project:openstack/stx-utils)%20status:open%20NOT%20owner:self%20NOT%20label:Workflow%3C=-1%20label:Verified%3E=1,zuul%20NOT%20reviewedby:self&title=StarlingX%20Review%20Inbox&Needs%20final%20%202=label:Code-Review%3E=2%20limit:50%20NOT%20label:Code-Review%3C=-1,self&Passed%20Zuul,%20No%20Negative%20Feedback%20(Small%20Fixes)=NOT%20label:Code-Review%3E=2%20NOT%20label:Code-Review%3C=-1,starlingx-core%20delta:%3C=10&Passed%20Zuul,%20No%20Negative%20Feedback=NOT%20label:Code-Review%3E=2%20NOT%20label:Code-Review%3C=-1,starlingx-core%20delta:%3E10&Needs%20Feedback%20(Changes%20older%20than%205%20days%20that%20have%20not%20been%20reviewed%20by%20anyone)=NOT%20label:Code-Review%3C=-1%20NOT%20label:Code-Review%3E=1%20age:5d&You%20are%20a%20reviewer,%20but%20haven't%20voted%20in%20the%20current%20revision=NOT%20label:Code-Review%3C=-1,self%20NOT%20label:Code-Review%3E=1,self%20reviewer:self&Wayward%20Changes%20(Changes%20with%20no%20code%20review%20in%20the%20last%202days)=NOT%20is:reviewed%20age:2d StarlingX Gerrit Review Dashboard]
+
* [[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 -->
  
−
== Story and Bug Tracking ==
+
===== User resources  =====
−
We will mark each new Storyboard story with a Tag to
+
----
−
* Show what kind of a Story it is - a Bug, a Feature, etc...
+
* [https://docs.starlingx.io/deploy_install_guides/index-install-e083ca818006.html Installation and Deployment Guides]
−
* Show what release the Story is targeted to: stx.2018.08, stx.2018.11, etc... See the TBD section for more info on our Release plans
+
* [[StarlingX/Platform Features|Hardware platform features]]
−
* Show which sub-project of Starling is responsible for completing the Story. See the TBD section for more info on the project's sub-projects
+
* [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 ]
  
−
Tagging new stories is mandatory. 
 
  
−
Tags for Story kinds currently defined are:
+
|style="vertical-align:top; width:25%;" |
−
* "stx.bug" - for defects
+
<!-- 2nd table 2nd column contents -->
−
* "stx.feature" - for new features
 
  
−
Tags for Releases currently defined are:
+
===== Code =====
−
* "stx.2018.08" - for bugs or features intended to be completed before the August code freeze for the September release
+
----
−
* "stx.2018.11" - for bugs or features intended to be completed before the November code freeze for the December release
+
* [https://opendev.org/starlingx Source code repositories]
 +
* [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]
 +
* [https://starlingx.biterg.io Bitergia Code Stats]
  
−
Tags for Sub-projects currently defined are:
+
|style="vertical-align:top; width:25%;" |
−
* "stx.security" - for defects and features for the Security sub-project
+
<!-- 2nd table 3rd column contents -->
−
* Additional tags e.g. for the project sub-projects will be defined shortly
 
  
−
* '''Prefixes''': To make it easier to visually identify categories of work and to search on them, you can optionally add a prefix to the description for a Story. The following prefixes are defined:
+
===== Governance =====
−
** [Bug]: A problem which impairs or prevents the functionality of StarlingX
+
----
−
** [Enhancement]: An improvement or enhancement to the functionality of StartingX; typically smaller scope items
+
* [https://docs.starlingx.io/governance/index.html Governance documents]
−
** [Feature]: A new feature/functionality to be added to StarlingX. Ideally, the scope should fit within a release time-frame (ex: 3-6 months)
+
* [https://docs.starlingx.io/election/ Election documents and results]
−
** [Build]: Build tools, environment, repo organization, etc
+
* [https://etherpad.openstack.org/p/stx-governance Archive: Draft governance etherpad]
−
** [Process]: Process and project related work items
+
* [[Starlingx/Initial Governance|Archive: Draft governance wiki]]
−
** [Test]: Test/Validation related work items
+
|style="vertical-align:top; width:25%;" |
−
** [Doc]: Documentation related work items
+
<!-- 2nd table 4th column contents -->
−
** [Upstreaming]: Work items that need to be pushed in the core openstack projects or other 3rd party repo's
+
===== Meetups & PTGs =====
−
** [Help]: Request for assistance, questions
+
----
−
** Same Queries:
+
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
−
*** Active Features: https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Feature
+
* [https://etherpad.openstack.org/p/stx-chandler-meetup Jan 2019 meetup etherpad]
−
*** Active Bugs: https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Bug
+
* [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 -->
  
−
* '''Tags''': Tags can also be used to facilitate searches. Proposed StarlingX tags: TBD
+
===== Planning & Processes =====
 +
----
 +
* [[StarlingX/Release_Plan|StarlingX Release Planning]]
 +
* [https://docs.starlingx.io/contributor/development_process.html Development Process]
 +
* [[StarlingX/Tags and Prefixes|Tags and Prefixes]] 
 +
* [https://storyboard.openstack.org/#!/project_group/86 Storyboard Group]
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 3rd table 2nd column contents -->
  
−
* [https://storyboard.openstack.org/#!/worklist/354 StarlingX Bug List]
+
===== Useful queries =====
−
** This list is sorted manually by drag and drop.
+
----
−
** 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
+
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86 All active stories]
−
** After you create the bug, please add it to the Bug Worklist (link above). 
+
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.4.0 All active stories for StarlingX 4.0]
−
** If you don't see the "add a card" button on the Worklist, you need to be added as a user of the Worklist.  Please contact bruce.e.jones@intel.com to be added.
+
* [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]
  
−
== References ==
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 3rd table 3rd column contents -->
  
−
* [https://etherpad.openstack.org/p/stx-notes The list of repos] and other things
+
===== StarlingX sub-projects =====
 +
----
 +
* [[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)]]
  
−
== OpenStack Documentation ==
 
  
−
These are references to general OpenStack material:
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 4th column contents -->
  
−
* [https://docs.openstack.org/infra/manual/developers.html Developer's Guide]
+
===== Special Interest Groups (SIGs) =====
−
* [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)
+
* [[StarlingX/Packet SIG|Packet SIG]]  
−
* [https://governance.openstack.org/tc/reference/project-testing-interface.html Project Testing Interface]
+
* [[StarlingX/First Contact SIG|First Contact SIG]]
 +
|}
  
−
|style="vertical-align:top; width:50%;" |
+
The previous wiki home page can be found [[StarlingX/Archived wiki home page|here]]
−
<!-- right column contents -->
 
−
== Culture ==
 
−
 
 
−
We are proud to be an OpenStack Foundation project!
 
−
* We support and adhere to the [https://www.openstack.org/legal/community-code-of-conduct/ OpenStack community Code of Conduct]
 
−
* We support and fully embrace the [https://governance.openstack.org/tc/reference/opens.html Four Opens]
 
−
* [[StarlingX/Contribution Guidelines|Contribution Guidelines]]
 
−
 
 
−
== Meetings ==
 
−
 
 
−
=== Weekly calls ===
 
−
 
 
−
* We host a weekly call for the project every Wednesday at 7am PDT / 1400 UTC.  All are welcome.
 
−
* We also host a Core team call every Thursday at 7AM PDT / 1400 UTC.  This is for the Core team but other project participants are welcome to join.
 
−
 
 
−
==== Call details ====
 
−
 
 
−
* ''' Zoom link: https://zoom.us/j/342730236 '''
 
−
* ''' Dialing in from phone: '''
 
−
** Dial(for higher quality, dial a number based on your current location): US: +1 669 900 6833  or +1 646 876 9923
 
−
** Meeting ID: 342 730 236
 
−
** International numbers available: https://zoom.us/u/ed95sU7aQ
 
−
 
 
−
==== Agenda and meeting minutes ====
 
−
 
 
−
The agenda and notes for each call are kept in Etherpads:
 
−
* [https://etherpad.openstack.org/p/stx-status Weekly Agenda and Notes]
 
−
* [https://etherpad.openstack.org/p/stx-cores Weekly Core team Agenda and Notes]
 
−
 
 
−
Please feel free to add items to the agendas for these meetings.
 
−
 
 
−
=== PTG Meetings ===
 
−
 
 
−
We are preparing for the Denver OpenStack PTG meeting.  Draft agenda items can be found here:
 
−
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver PTG Agenda]
 
−
== Status and Planning ==
 
−
 
 
−
* [[StarlingX/Release Plan|Release Plan]]
 
−
* [https://storyboard.openstack.org/#!/project_group/86 StarlingX Storyboards]
 
−
* [https://etherpad.openstack.org/p/stx-planning StarlingX Planning Etherpad] (contains sub-projects and Worklists)
 
−
* [[StarlingX/Project Priorities|Project Priorities]]
 
−
* [[StarlingX/Project Plans|Project Plans]]
 
−
 
 
−
== Upstream Status ==
 
−
 
 
−
The StarlingX code base contains a number of out-of-tree patches against other open source components.  One of our highest priorities is to contribute those changes to their upstream communities.
 
−
 
 
−
TODO: Add a link to our Dashboard showing the status of upstream submissions
 
−
|}
 

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

Retrieved from "https://wiki.openstack.org/w/index.php?title=StarlingX&oldid=184096"