Jump to: navigation, search

Difference between revisions of "StarlingX/Draft new wiki home page"

(Releases)
 
(39 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
<center>
 
<center>
  
== Welcome to the StarlingX Project ==
+
== Welcome to the StarlingX Community ==
''This is a work-in-progress draft of a new look for the StarlingX wiki home page.  Comments and feedback welcome! Please send them to (bruce dot e dot jones at intel dot com)''.
+
'''This is the draft of a new version of the StarlingX wiki home page.  It went live as the home page on June 26th. This page is preserved for archival use only.'''
  
 +
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>
=== Introduction ===
+
----
StarlingX is a fully integrated Edge Cloud software stack that includes everything that you need to deploy an Edge Cloud on one server, two servers, or up to 100 servers. It includes a host operating system, storage and networking components, and all of the Cloud Infrastructure needed to run Edge workloads in one easy to install package.  All of the software has been tuned and optimized to meet Edge application requirements.
 
  
The stack pre-defines several different configurations that are designed to meet a variety of Edge Cloud deployment needs.
+
<!-- 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's goal is to make the task of deploying and managing a high performance Edge Cloud as simple as possible.
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 2nd column contents -->
 +
===== Culture =====
 
----
 
----
=== Learn more ===
+
* [https://www.openstack.org/legal/community-code-of-conduct/ Code of Conduct]
See the [https://www.starlingx.io/ main StarlingX web site] for more information about the project and the [https://docs.starlingx.io/ StarlingX Documentation site] for a more complete introduction to the project as well as the project's documentation.
+
* [https://governance.openstack.org/tc/reference/opens.html The Four Opens]
  
You can find an overview of the StarlingX project's features  [https://www.starlingx.io/learn/ here].
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 3rd column contents -->
 +
===== Communicate =====
 
----
 
----
=== Culture ===
+
* [http://lists.starlingx.io/ Email lists]
We are proud to be an OpenStack Foundation project!
+
* IRC: #starlingX@freenode
* We support and adhere to the [https://www.openstack.org/legal/community-code-of-conduct/ OpenStack community Code of Conduct]
+
* [https://docs.openstack.org/infra/manual/developers.html IRC setup]
* We support and fully embrace the [https://governance.openstack.org/tc/reference/opens.html Four Opens]
+
* [[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 =====
 
----
 
----
=== Communicate ===
+
* [https://docs.starlingx.io/contributor/index.html Developer Guide]
* Email: See http://lists.starlingx.io/ to subscribe to starlingx-announce or starlingx-discuss.
+
* [[StarlingX/StarlingX VirtualBox Configuration Guide | VirtualBox Guide]]
* IRC: #starlingX on freenode. See [https://docs.openstack.org/infra/manual/developers.html here] for info on IRC account setup.
+
* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com iPXE]]
* Weekly calls: The list of meetings and dial-in information can be found [[Starlingx/Meetings|on this page.]]
+
* [[StarlingX/Contribution Guidelines|Contribution guidelines]]
 +
* [[StarlingX/CodeSubmissionGuidelines|Code Submission 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="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 1st column contents -->
 +
===== User resources  =====
 
----
 
----
 +
* [https://docs.starlingx.io/installation_guide/index.html Installation Guide]
 +
* [[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]
  
=== Users and Operators ===
+
|style="vertical-align:top; width:25%;" |
This section of the wiki contains information aimed at users and operators of StarlingX.
+
<!-- 2nd table 2nd column contents -->
==== Releases ====
+
===== Code =====
The first StarlingX release is stx.1.0 (previously referred to as stx.2018.10) and it is available now.  The second StarlingX release is stx.2.0 and is expected to be ready in August of 2019.
+
----
{| class=wikitable
+
* [https://opendev.org/starlingx Source code repositories]
|- style="vertical-align:top;"
+
* [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]  
| '''Release''' || '''Description''' || '''Release Date''' || '''Prebuilt Image''' || '''Release Notes'''
 
|-
 
| Stx.1.0
 
| StarlingX 1.0 is an OpenStack Pike platform that can manage application workloads in Virtual Machines or on Bare Metal.  It is the most recent stable release of StarlingX.
 
| October 2018
 
| [http://mirror.starlingx.cengn.ca/mirror/starlingx/centos/2018.10/20181110/outputs/iso/ stx.1.0]
 
| [https://docs.starlingx.io/releasenotes/index.html stx.1.0 Release Notes]
 
|-
 
| Stx.2.0
 
| StarlingX 2.0 adds Container support with Kubernetes and runs OpenStack Stein within containers as an optional application.  It has not yet been released.
 
| August 2019
 
| Not yet available
 
| Not yet available
 
|-
 
| Stx.3.0
 
| To be defined
 
| November 2019
 
| Not yet available
 
| Not yet available
 
|-
 
| Latest nightly builds
 
| These builds are a preview of our upcoming release and are under active development by the community.
 
| Not applicable
 
| [http://mirror.starlingx.cengn.ca/mirror/starlingx/master/centos/ Latest builds]
 
| Not applicable
 
|}
 
  
==== Documentation ====
+
|style="vertical-align:top; width:25%;" |
Documentation on how to use, build and install StarlingX is available [https://docs.starlingx.io on StarlingX documentation page].  There is additional documentation available on this wiki:
+
<!-- 2nd table 3rd column contents -->
* [https://docs.starlingx.io/contributor/index.html StarlingX Developer Guide]
 
* [https://docs.starlingx.io/installation_guide/index.html StarlingX Installation Guide]
 
* [[StarlingX/StarlingX VirtualBox Configuration Guide | StarlingX VirtualBox Configuration Guide]]
 
* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com  iPXE Installation]]
 
  
==== Platform features ====
+
===== Governance =====
Features that are unique to a specific hardware platform are described [[StarlingX/Platform Features|here]].
+
----
 +
* [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 =====
 
----
 
----
 
=== Contributors ===
 
Please follow our [[StarlingX/Contribution Guidelines|contribution guidelines]],  [[StarlingX/CodeSubmissionGuidelines|Code Submission Guidelines]]
 
and [https://docs.starlingx.io/contributor/api_contribute_guide.html StarlingX API Contributor Guide]
 
==== New Contributor Info ====
 
Your contribution is welcome - check the list of [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.helpwanted "help wanted" bugs].
 
==== Contributor Info ====
 
The StarlingX project uses Gerrit as its web-based code change management and review tool.  The following links and queries are helpful for finding out what reviews are active in the project:
 
* [https://opendev.org/starlingx Gerrit repositories] maintain the StarlingX code, build instructions are in the [https://docs.starlingx.io/developer_guide/index.html StarlingX Developer Guide]
 
* [https://review.opendev.org/#/admin/projects/?filter=starlingx StarlingX Gerrit Projects] and [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Open StarlingX project reviews]
 
* [https://review.openstack.org/#/dashboard/?foreach=(project:openstack/stx-clients%20OR%20project:openstack/stx-config%20OR%20project:openstack/stx-distcloud%20OR%20project:openstack/stx-distcloud-client%20OR%20project:openstack/stx-fault%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-tools%20OR%20project:openstack/stx-update%20OR%20project:openstack/stx-upstream)%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]
 
* [https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fstx-clients+OR+project%3Aopenstack%2Fstx-config+OR+project%3Aopenstack%2Fstx-distcloud+OR+project%3Aopenstack%2Fstx-distcloud-client+OR+project%3Aopenstack%2Fstx-fault+OR+project%3Aopenstack%2Fstx-gui+OR+project%3Aopenstack%2Fstx-ha+OR+project%3Aopenstack%2Fstx-integ+OR+project%3Aopenstack%2Fstx-manifest+OR+project%3Aopenstack%2Fstx-metal+OR+project%3Aopenstack%2Fstx-nfv+OR+project%3Aopenstack%2Fstx-root+OR+project%3Aopenstack%2Fstx-tools+OR+project%3Aopenstack%2Fstx-update+OR+project%3Aopenstack%2Fstx-upstream%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D-1+label%3AVerified%3E%3D1%2Czuul+NOT+reviewedby%3Aself&title=StarlingX+Review+Inbox&Needs+final+%2B2=label%3ACode-Review%3E%3D2+limit%3A50+NOT+label%3ACode-Review%3C%3D-1%2Cself&Passed+Zuul%2C+No+Negative+Feedback+%28Small+Fixes%29=NOT+label%3ACode-Review%3E%3D2+NOT+label%3ACode-Review%3C%3D-1%2Cstarlingx-core+delta%3A%3C%3D10&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode-Review%3E%3D2+NOT+label%3ACode-Review%3C%3D-1%2Cstarlingx-core+delta%3A%3E10&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode-Review%3C%3D-1+NOT+label%3ACode-Review%3E%3D1+age%3A5d&You+are+a+reviewer%2C+but+haven't+voted+in+the+current+revision=NOT+label%3ACode-Review%3C%3D-1%2Cself+NOT+label%3ACode-Review%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 by Status]
 
==== Meetings ====
 
===== Weekly calls =====
 
* The list of meetings and dial-in information can be found [[Starlingx/Meetings|on this page.]]
 
* We held a community meetup in January 2019.  The agenda and meeting notes [https://etherpad.openstack.org/p/stx-chandler-meetup can be found here].  A blog with pictures and a description of the meetup [https://www.starlingx.io/blog/starlingx-meetup-january-2019.html is here].
 
===== PTG Meetings =====
 
Here are the agendas and notes for our PTG meetings:
 
 
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
 
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
 
* add link here to the Berlin PTG meeting minutes
 
* add link here to the Berlin PTG meeting minutes
 +
* [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/stx-ptg-agenda StarlingX Denver 2019 PTG Agenda and Notes]
===== Planning & Process =====
+
|}
 +
<!-- 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/Release_Plan|StarlingX Release Planning]]
* [[StarlingX/Feature Development Process|StarlingX Feature Development Process (in review)]]
+
* [[StarlingX/Feature Development Process|StarlingX Feature Development Process (needs update)]]
 
* [[StarlingX/Defect Handling Process|StarlingX Defect Handling Process]]
 
* [[StarlingX/Defect Handling Process|StarlingX Defect Handling Process]]
===== Story and Bug Tracking =====
+
* [[StarlingX/Tags and Prefixes|Tags and Prefixes]] 
We are using the OpenStack Storyboard tool for tracking feature development activities. Each new Story should be marked with one or more Tags, and can optionally include one or more Prefixes in the title. See [[StarlingX/Tags and Prefixes|Tags and Prefixes]] for a description of how we use them.
+
* [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].
  
The StarlingX Storyboard project group is [https://storyboard.openstack.org/#!/project_group/86 here].
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 3rd table 3rd column contents -->
 +
===== StarlingX sub-projects =====
 +
----
 +
* [[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]]
 +
* [[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]]
  
We are using [https://bugs.launchpad.net/starlingx Launchpad] for tracking bugs. '''IMPORTANT:''' If you create a new bug, please use [[StarlingX/BugTemplate|the StarlingX Bug Template]].
+
|style="vertical-align:top; width:25%;" |
 
+
<!-- 1st table 4th column contents -->
Sample queries:
+
===== Special Interest Groups (SIGs) =====
* To find newly created stories, use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.new this query]
+
----
* To find stories with no sub-project tags, use [https://storyboard.openstack.org/#!/worklist/456 this worklist]
+
* [[StarlingX/Packet SIG|Packet SIG]]  
* To find all active stories, use [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86 this query]
+
* [[StarlingX/First Contact SIG|First Contact SIG]]
* To find all active stories for stx.2.0, use  [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.2.0 this query]
 
* To find all active bugs for stx.2.0 in launchpad, use [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.2018.10 this query].
 
* Queries for the Sub-projects are defined on each Sub-project's page
 
==== 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]]
 
|}
 
===== StarlingX supporting projects =====
 
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.
 
{| class="wikitable"
 
|-
 
| [[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 cross-project initiatives =====
 
There are several initiatives we are implementing that cross project boundaries:
 
{| class="wikitable"
 
|-
 
| [[StarlingX/Pyton2|Python2 to Python3 Transition]]|| [[StarlingX/Zull|Zuul Enablement and Coverage]]
 
|-
 
| [[StarlingX/Devstack|Devstack Integration]] || [[StarlingX/stxinabox|StarlingX In-a-box]]
 
 
|}
 
|}
ToDo:
 
* Create a Project Map graphic that captures all of this in a graphical way, similar to (or an extension of) the OpenStack project map.
 
==== 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 ===
+
The previous wiki home page can be found [[StarlingX/Archived wiki home page|here]]
 
 
You can find more information about StarlingX governance and the TSC charter on the [https://docs.starlingx.io/governance/index.html governance section] of the documentation website.
 
 
 
For early versions and evolution of the documents see [https://etherpad.openstack.org/p/stx-governance here] and [[Starlingx/Initial Governance|on this wiki page.]]
 
----
 

Latest revision as of 17:56, 26 June 2019

Welcome to the StarlingX Community

This is the draft of a new version of the StarlingX wiki home page. It went live as the home page on June 26th. This page is preserved for archival use only.

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