Jump to: navigation, search

Difference between revisions of "StarlingX"

(→‎StarlingX main projects)
(→‎Developer Resources)
(94 intermediate revisions by 16 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 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]
  
−
You can find an overview of the StarlingX project's features <insert link here>.
+
|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]
  
−
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 3rd column contents -->
 +
===== Communicate =====
 
----
 
----
−
<!-- the rest of the page is a two-column table -->
+
* [http://lists.starlingx.io/ Email lists]
 +
* IRC: #starlingX@freenode
 +
* [https://docs.openstack.org/infra/manual/developers.html IRC setup]
 +
* [[Starlingx/Meetings|Weekly calls schedule]]
 +
* [https://zoom.us/j/342730236 Weekly calls Zoom]
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 4th column contents -->
 +
===== Developer Resources =====
 +
----
 +
* [https://docs.openstack.org/infra/manual/developers.html Developer Guide]
 +
* [[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://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%;" |
−
<!-- left column contents -->
+
<!-- 2nd table 1st column contents -->
  
−
== Documentation ==
+
===== 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]
  
−
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]]
+
<!-- 2nd table 2nd column contents -->
−
* [[StarlingX/Installation Guide|Installation Guide]]
 
−
* [[StarlingX/Validation Guide|Validation Guide]]
 
  
−
== Code ==
+
===== Code =====
−
The StarlingX project uses Gerrit as its web-based code change management and review tool.
+
----
−
* [https://git.starlingx.io/cgit Gerrit repositories] maintain the StarlingX code, build instructions are in the [[StarlingX/Developer Guide]]
+
* [https://opendev.org/starlingx Source code repositories]
−
* [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://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]  
−
* [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]
 
  
−
== Story and Bug Tracking ==
+
|style="vertical-align:top; width:25%;" |
−
We are using the OpenStack Storyboard tool for tracking all development activities.  Each new Story shall be marked with one or more Tags, and can optionally include one or more Prefixes in the description.    See [[StarlingX/Tags and Prefixes|Tags and Prefixes]] for a description of how we use them. 
+
<!-- 2nd table 3rd column contents -->
  
−
'''IMPORTANT:''' If you create a new Story (of any kind), please mark it with the tag "stx.new" so we can find it, review it and assign it to the right team and a release.
+
===== Governance =====
−
 
+
----
−
The StarlingX Storyboard project group is [https://storyboard.openstack.org/#!/project_group/86 here].
+
* [https://docs.starlingx.io/governance/index.html Governance documents]
−
 
+
* [https://docs.starlingx.io/election/ Election documents and results]
−
Sample queries:
+
* [https://etherpad.openstack.org/p/stx-governance Archive: Draft governance etherpad]
−
* To find the newly created stories use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.new this query]
+
* [[Starlingx/Initial Governance|Archive: Draft governance wiki]]
−
* To find all of the active bugs use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.bug this query]
+
|style="vertical-align:top; width:25%;" |
−
* To find all of the active bugs assigned to the stx.2018.08 release use [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.bug&tags=stx.2018.08 this query]
+
<!-- 2nd table 4th column contents -->
−
* To find all of the active bugs assigned to the stx.2018.11 release use [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.bug&tags=stx.2018.11 this query]
+
===== Meetups & PTGs =====
−
 
+
----
−
Queries for the Sub-projects will be defined on each Sub-project's page
+
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
−
 
+
* add link here to the Berlin PTG meeting minutes
−
You can also use Prefixes to search for Stories but we consider Prefixes optional so these searches might not show the same results as searching for Tags.
+
* [https://etherpad.openstack.org/p/stx-chandler-meetup Jan 2019 meetup etherpad]
−
* Sample Prefix queries:
+
* [https://www.starlingx.io/blog/starlingx-meetup-january-2019.html Jan 2019 meetup blog]
−
** To find all Stories with the [Features] prefix use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Feature this query]
+
* [https://etherpad.openstack.org/p/stx-ptg-agenda StarlingX Denver 2019 PTG Agenda and Notes]
−
** To find all Stories with the [Bug] prefix use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Bug this query]
 
−
 
 
−
== References ==
 
−
 
 
−
* [https://etherpad.openstack.org/p/stx-notes The list of repos] and other things
 
−
 
 
−
== OpenStack Documentation ==
 
−
 
 
−
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]
 
−
 
 
−
== Governance ==
 
−
 
 
−
A very preliminary Governance document can be found [https://etherpad.openstack.org/p/stx-governance here].
 
−
 
 
−
|style="vertical-align:top; width:50%;" |
 
−
<!-- 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]]
 
−
* The mailing lists are now live at http://lists.starlingx.io/.  There are two lists, starlingx-announce and starlingx-discuss.  Please subscribe.
 
−
* We have the #starlingX IRC channel set up on freenode. Refer to https://docs.openstack.org/infra/manual/developers.html regarding how to have your IRC account setup.
 
−
 
 
−
== 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 ==
 
−
This section is under construction.
 
−
=== Overall project planning pages ===
 
−
* [[StarlingX/Project Priorities|Project Priorities]]
 
−
* [[StarlingX/Release Plan|Release Plan]]
 
−
* [https://etherpad.openstack.org/p/stx-planning StarlingX Planning Etherpad] (contains sub-projects and Worklists)
 
−
* [[StarlingX/Project Plans|Project Plans]]
 
−
 
 
−
=== StarlingX Projects ===
 
−
StarlingX is both a development project and an integration project that combines new services with many other open source projects into an overall Edge Cloud software stack.  We've broken the overall project into a set of separate projects to help keep things manageable.
 
−
Notes from the F2F discussion on how to organize sub-teams are [https://ethercalc.openstack.org/ctjc7vlbphm1 here]
 
−
==== StarlingX main projects ====
 
−
Information on the main StarlingX development projects can be found on the wiki pages below:
 
−
{| class=wikitable
 
−
|-
 
−
| [[StarlingX/Config|Config project]]|| [[StarlingX/Fault|Fault project]]
 
−
|-
 
−
|  [[StarlingX/HA|HA project]] || [[StarlingX/GUI|GUI project]]
 
−
|-
 
−
| [[StarlingX/Metal|Metal project]]|| [[StarlingX/NFV|NFV project]]
 
−
|-
 
−
| [[StarlingX/Update|Update project]]|| [[StarlingX/DistCloud|Distributed Cloud project]]
 
 
|}
 
|}
 +
<!-- 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 -->
 +
===== Planning & Processes =====
 +
----
 +
* [[StarlingX/Release_Plan|StarlingX Release Planning]]
 +
* [[StarlingX/Feature Development Process|StarlingX Feature Development Process (needs update)]]
 +
* [[StarlingX/Defect Handling Process|StarlingX Defect Handling 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 -->
 +
===== Useful queries =====
 +
----
 +
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.new Newly created stories]
 +
* [https://storyboard.openstack.org/#!/worklist/456 Stories with no sub-project tags]
 +
* [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.2.0 All active stories for StarlingX 2.0]
 +
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.2.0 All open bugs for StarlingX 2.0].
  
−
==== StarlingX supporting projects ====
+
|style="vertical-align:top; width:25%;" |
−
In addition to the main StarlingX development projects there are also additional projects to help us develop, maintain, document, build and release the overall StarlingX software stack.
+
<!-- 3rd table 3rd column contents -->
−
{| class="wikitable"
+
===== StarlingX sub-projects =====
−
|-
+
----
−
| [[StarlingX/Docs_and_Infra|Docs and Infra project]]|| [[StarlingX/Build|Build project]]
+
* [[StarlingX/Config|Config project]]
−
|-
+
* [[StarlingX/Fault|Fault project]]
−
| [[StarlingX/DistroOpenStack|Distro - OpenStack project]] ||  [[StarlingX/Distro|Distro - Non-OpenStack project]]
+
* [[StarlingX/HA|HA project]]
−
|-
+
* [[StarlingX/GUI|GUI project]]
−
| [[StarlingX/Test|Test project]]||  [[StarlingX/Security|Security project]]
+
* [[StarlingX/Metal|Metal project]]
−
|-
+
* [[StarlingX/NFV|NFV project]]
−
| [[StarlingX/Containers|Containers project wiki]]||  [[StarlingX/Networking|Networking project wiki]]
+
* [[StarlingX/Update|Update project]]
−
|-
+
* [[StarlingX/DistCloud|Distributed Cloud project]]
−
| [[StarlingX/Releases|Releases project wiki]] ||  
+
* [[StarlingX/Docs_and_Infra|Docs and Infra project]]
−
|}
+
* [[StarlingX/Build|Build project]]
 +
* [[StarlingX/DistroOpenStack|Distro - OpenStack project]]
 +
* [[StarlingX/Distro|Distro - Non-OpenStack project]]
 +
* [[StarlingX/Test|Test project]]
 +
* [[StarlingX/Security|Security project]]
 +
* [[StarlingX/Containers|Containers project]]
 +
* [[StarlingX/Networking|Networking project]]
 +
* [[StarlingX/Releases|Releases project]]
 +
* [[StarlingX/MultiOS|MultiOS project]]
 +
* [[StarlingX/Pyton2|Python2 to Python3 Transition]]
 +
* [[StarlingX/Zull|Zuul Enablement and Coverage]]
 +
* [[StarlingX/Devstack|Devstack Integration]]
 +
* [[StarlingX/stxinabox|StarlingX In-a-box]]
  
−
==== StarlingX cross-project initiatives ====
+
|style="vertical-align:top; width:25%;" |
−
There are several initiatives we are implementing that cross project boundaries:
+
<!-- 1st table 4th column contents -->
−
{| class="wikitable"
+
===== Special Interest Groups (SIGs) =====
−
|-
+
----
−
| [[StarlingX/Pyton2|Python2 to Python3 Transition]]|| [[StarlingX/Zull|Zuul Enablement and Coverage]]||  [[StarlingX/Devstack|Devstack Integration]]
+
* [[StarlingX/Packet SIG|Packet SIG]]  
 +
* [[StarlingX/First Contact SIG|First Contact SIG]]
 
|}
 
|}
−
ToDo:
 
−
* Add a cross project initiative (or new project) for Multi-OS support
 
−
* Add a vendor project for Intel platform specific features e.g. FPGA access in guests, GPU support in guests, Intel SGX and EPID support and NEV SDK integration
 
−
* Create a Project Map graphic that captures all of this in a graphical way, similar to (or an extension of) the OpenStack project map.
 
  
−
== Upstream Status ==
+
The previous wiki home page can be found [[StarlingX/Archived wiki home page|here]]
−
 
 
−
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
 
−
|}
 

Revision as of 15:35, 16 July 2019

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 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=171097"