Jump to: navigation, search

Difference between revisions of "StarlingX"

m (Developer Resources)
 
(216 intermediate revisions by 22 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__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="border-collapse: separate; border-spacing: 25px;"
| style="vertical-align:top; width:50%;" | Intel and Wind River have jointly open sourced components from the [https://www.windriver.com/products/titanium-cloud/ Wind River® Titanium Cloud] portfolio, with code being upstreamed to a new open source project called [https://starlingx.io StarlingX], and hosted by the OpenStack Foundation.
+
|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]
  
 +
|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]
  
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.
+
|style="vertical-align:top; width:25%;" |
 
+
<!-- 1st table 3rd column contents -->
The StarlingX project opens many of these enhancements to the open source community, giving others a reference platform upon which to innovate. Through the StarlingX project, Intel and Wind River invite the community to contribute code, and look forward to working together to define the infrastructure stack for edge computing and accelerating integration across many existing open source projects including cloud native technologies.
+
===== Communicate =====
| style="vertical-align:top; width:50%;" | The code made available via the StarlingX project will:
+
----
* Provide service management, REST APIs, and process monitoring
+
* [http://lists.starlingx.io/ Email lists]
* Deliver standalone fault management service, including extensions to OpenStack Horizon
+
* IRC: #starlingX@freenode
* Provide software repository management, patching, upgrade, backup, and restore services
+
* [https://docs.openstack.org/infra/manual/developers.html IRC setup]
* 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
+
* [[Starlingx/Meetings|Weekly calls schedule]]
 
+
* [https://zoom.us/j/342730236 Weekly calls Zoom]
 
+
|style="vertical-align:top; width:25%;" |
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.
+
<!-- 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/CodeSubmissionGuidelines|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://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.helpwanted "Help wanted" bugs]
 
|}
 
|}
----
 
 
{| style="border-collapse: separate; border-spacing: 25px;"
 
{| style="border-collapse: separate; border-spacing: 25px;"
|style="vertical-align:top; width:50%;" |
+
|style="vertical-align:top; width:25%;" |
== Documentation ==
+
<!-- 2nd table 1st column contents -->
  
* Under development
+
===== User resources  =====
 +
----
 +
* [https://docs.starlingx.io/deploy_install_guides/index.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]
  
== Code ==
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 2nd column contents -->
  
* [https://git.openstack.org/cgit/openstack/stx Gerrit repositories]
+
===== Code =====
** Instructions for how to download and build the code are in progress
+
----
* [https://review.openstack.org/ Gerrit Web UI]
+
* [https://opendev.org/starlingx Source code repositories]
* [https://review.openstack.org/#/admin/projects/?filter=stx StarlingX Gerrit Projects]]
+
* [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]  
** Hint for fast review of open reviews related to STX, in search box use the regular expression "status:open AND project:^openstack/stx-@"
 
* [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]
 
** Also in [http://paste.openstack.org/show/723397/ StarlingX Gerrit Review Dashboard] (copy the URL from there into a browser bookmark)
 
  
== Bug Tracking ==
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 3rd column contents -->
  
* [https://storyboard.openstack.org/#!/worklist/354 StarlingX Bug List]
+
===== Governance =====
** 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://docs.starlingx.io/governance/index.html Governance documents]
** After you create the bug, please add it to the Bug Worklist (link above)
+
* [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]
 +
|}
 +
<!-- 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 -->
  
|style="vertical-align:top; width:50%;" |
+
===== Planning & Processes =====
== Status and Planning ==
+
----
 +
* [[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://etherpad.openstack.org/p/stx-status Status Meeting Notes]
+
===== Useful queries =====
* [https://storyboard.openstack.org/#!/project_group/86 StarlingX Storyboards]]
+
----
* [https://etherpad.openstack.org/p/stx-planning StarlingX Planning] (contains sub-projects and Worklists)
+
* [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%0Aproject%3Astarlingx%2Fansible%2Dplaybooks+OR%0Aproject%3Astarlingx%2Fclients+OR%0Aproject%3Astarlingx%2Fcompile+OR%0Aproject%3Astarlingx%2Fconfig+OR%0Aproject%3Astarlingx%2Fconfig%2Dfiles+OR%0Aproject%3Astarlingx%2Fcontainers+OR%0Aproject%3Astarlingx%2Fdistcloud+OR%0Aproject%3Astarlingx%2Fdistcloud%2Dclient+OR%0Aproject%3Astarlingx%2Fdocs+OR%0Aproject%3Astarlingx%2Felection+OR%0Aproject%3Astarlingx%2Ffault+OR%0Aproject%3Astarlingx%2Fgovernance+OR%0Aproject%3Astarlingx%2Fgui+OR%0Aproject%3Astarlingx%2Fha+OR%0Aproject%3Astarlingx%2Fhelm%2Dcharts+OR%0Aproject%3Astarlingx%2Finteg+OR%0Aproject%3Astarlingx%2Fmanifest+OR%0Aproject%3Astarlingx%2Fmetal+OR%0Aproject%3Astarlingx%2Fmonitor%2Darmada%2Dapp+OR%0Aproject%3Astarlingx%2Fmonitoring+OR%0Aproject%3Astarlingx%2Fnfv+OR%0Aproject%3Astarlingx%2Fopenstack%2Darmada%2Dapp+OR%0Aproject%3Astarlingx%2Fplatform%2Darmada%2Dapp+OR%0Aproject%3Astarlingx%2Froot+OR%0Aproject%3Astarlingx%2Fspecs+OR%0Aproject%3Astarlingx%2Fstx%2Dpuppet+OR%0Aproject%3Astarlingx%2Ftest+OR%0Aproject%3Astarlingx%2Ftools+OR%0Aproject%3Astarlingx%2Fupdate+OR%0Aproject%3Astarlingx%2Fupstream+OR%0Aproject%3Astarlingx%2Futilities+OR%0Aproject%3Astarlingx%2Fzuul%2Djobs%0A%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/Config|Config project]]
 +
* [[StarlingX/Containers|Containers project]]
 +
* [[StarlingX/Devstack|Devstack Integration]]
 +
* [[StarlingX/DistCloud|Distributed Cloud project]]
 +
* [[StarlingX/Distro|Distro - Non-OpenStack project]]
 +
* [[StarlingX/DistroOpenStack|Distro - OpenStack project]]
 +
* [[StarlingX/Docs_and_Infra|Docs and Infra project]]
 +
* [[StarlingX/FlockServices|Flock Services project]]
 +
* [[StarlingX/MultiOS|MultiOS project]]
 +
* [[StarlingX/Networking|Networking project]]
 +
* [[StarlingX/Python2|Python2 to Python3 Transition]]
 +
* [[StarlingX/Releases|Releases project]]
 +
* [[StarlingX/Security|Security project]]
 +
* [[StarlingX/stxinabox|StarlingX In-a-box]]
 +
* [[StarlingX/Test|Test project]]
 +
* [[StarlingX/Zull|Zuul Enablement and Coverage]]
  
== OpenStack Documentation ==
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 4th column contents -->
  
These are references to general OpenStack material:
+
===== Special Interest Groups (SIGs) =====
 +
----
 +
* [[StarlingX/Packet SIG|Packet SIG]]
 +
* [[StarlingX/First Contact SIG|First Contact SIG]]
 +
|}
  
* [https://docs.openstack.org/infra/manual/developers.html Developer's Guide]
+
The previous wiki home page can be found [[StarlingX/Archived wiki home page|here]]
* [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]
 
|}
 

Latest revision as of 18:03, 7 February 2020

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