Commit Graph

51 Commits

Author SHA1 Message Date
Zuul 00ed48e9bc Merge "Define performance test suite framework" 2019-10-23 16:22:49 +00:00
VictorRodriguez 7c1936321d Define performance test suite framework
This specification will describe the scope of the performance framework,
use cases and how it can scale by new tests added by the community.

Change-Id: I844e1619772789edf571a598ce0b6e4561e4e94b
Signed-off-by: VictorRodriguez <victor.rodriguez.bahena@intel.com>
2019-10-04 17:01:43 -05:00
Robert Church 143a5269db Fix spec formatting errors
The incomplete formatting of these specs caused their headers to pollute
their associated "Approved Specifications" index.

To avoid this, prior to submitting a spec, a spec writer should run tox
locally and view the Sphinx output prior to gerrit upload.

Change-Id: Ide53e1b4120616919579996843ee2abc48692540
Signed-off-by: Robert Church <robert.church@windriver.com>
2019-09-30 01:46:12 -04:00
Zuul 05932b89d9 Merge "Adding spec: OVS-DPDk containerization" 2019-08-29 13:32:19 +00:00
chengli3 1173d0abf1 Adding spec: OVS-DPDk containerization
openstack-helm is enabling ovs-dpdk containerization support.
Considering the benefits of containerization, I would suggest to
containerize ovs-dpdk in StarlingX.

Change-Id: I6ef4f1ccfcc8dab42e7b3d75707bce1905f5d5e7
Story: 2005496
Signed-off-by: chengli3 <cheng1.li@intel.com>
2019-08-20 16:15:14 +08:00
Zuul 3bb3080439 Merge "Add Redfish support to Maintenance" 2019-07-25 14:23:25 +00:00
Eric MacDonald 8746c6c0b2 Add Redfish support to Maintenance
This story adds ``Redfish Platform Management`` support to Starling-X
Maintenance as a prioritized alternative to the existing less secure
IPMI support for the following board management functions

* Reset and Power On/Off Control
* Network Boot Override
* Sensor Monitoring

Starling-X Maintenance currently uses ``ipmitool`` to invoke board
management functions. Unfortunately however, IPMI is aged and not
evolving with the server market.

``Redfish`` is a new and emerging well-defined Platform Management
Application Programming Interface (API) standard that leverages modern
software, is more secure and is easier to use and understand compared
to IPMI.

Redfish API uses the HTTP protocol over a TCP/IP network using either
JSON or XML data schemas to leverage common Internet and web services
standards and modern tool chains to add new board management services
for modern host servers to meet today's system administrator demands.

Change-Id: I5ab5c4da4ffdd795bed043dee097fc1077752dcd
Story: 2005861
Task: 33665
Signed-off-by: Eric MacDonald <eric.macdonald@windriver.com>
2019-07-02 14:48:55 +00:00
Huifeng Le f3555d746a Adding spec: Time Sensitive Networking
Time Sensitive Networking (TSN) is a set of evolving standards developed
by IEEE to allow for time-sensitive traffic on Ethernet based LANs,
which provides bounded worst-case latency. It is a key technology that
targets different segments such as Automotive, Industrials etc.

TSN enabling on StarlingX will be a large effort since TSN is composed
of multiple IEEE standards and varied use cases. This story will
implement the initial items (based on the most commonly used standards)
to integrate TSN on StarlingX to support real-time applications.

Change-Id: Ia642bdbd035f7ddcae598a1f6c806df277944b28
Story: 2005516
2019-06-27 09:50:40 +08:00
Scott Rifenbark 25cb850392 MultiOS directory layout formatting fixed.
Story: 2004891
Task: 29188

I inserted the proper directives to render the tree structure
properly.

Change-Id: Ib6142d3ee2c9fcf5a8cf3c2bf564245f64330e08
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-06-05 15:41:59 -07:00
VictorRodriguez 997155882a Define Flock services directory layout for MultiOS
This specification will extend the current Flock services directory structure
to support more operating systems apart from the current CentOS OS supported.

Change-Id: Ib518d6814b06929ee6a44ffc71043c9c43e189f3
Signed-off-by: Victor Rodriguez <victor.rodriguez.bahena@intel.com>
Suggested-by: Saul Wold <saul.wold@intel.com>
2019-05-22 16:56:18 -05:00
Bruce Jones e4e5d18622 Fix bug 1829063: Docuementation spec headers show up in Spec index page
Fix the main header line in the Documentation Mega Spec so that
it doesn't cause the headers within the document to show up on
the main spec index page.

Closes-Bug: 1829063

Change-Id: I598739e13924cd6f6491923061577d0cc21d7082
Signed-off-by: Bruce Jones <bruce.e.jones@intel.com>
2019-05-14 14:29:54 -07:00
Zuul 1af261b4e2 Merge "Documentation Mega Spec" 2019-03-18 13:24:57 +00:00
Bruce Jones 61a2d08670 Documentation Mega Spec
This specification describes a major change for the StarlingX
documentation (stx.docs / docs.starlingx.io) designed to address
use cases for users, operators and contributors.  It proposes
both a refactoring of the existing documentation and the creation
of a large number of additional documents.  A large number of
StoryBoard stories will be created from the proposal in this
document, which will all be prioritized as described in the spec.

I am pleased to submit this spec for review on behalf of the Docs
team and would like to thank Michael, Kris, Scott, Abraham and
Greg for their many contributions to this spec.

Change-Id: I48e3728e576ca72f00c77a049d5e5d8a229ab3de
Signed-off-by: Bruce Jones <bruce.e.jones@intel.com>
2019-03-08 15:21:34 -08:00
Abraham Arce 12a4041353 STX Example Spec: Sections
Reformat sections to comply with other existing specification
templates (e.g. OpenStack Nova [0]).

[0] https://specs.openstack.org/openstack/nova-specs/specs/train/template.html

Change-Id: I170244cc519a0573bf51c0ae06abdf65ac20aaf9
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-03-05 07:31:45 -06:00
Jason McKenna 1bd070a63d Add spec for publishing build artifacts on server
This change adds the spec file which described how official
build artifacts will be published on the world-facing server.

Change-Id: I0704b3ecbd1f34138edc7c3a5efe5cd888821fe5
Signed-off-by: Jason McKenna <jason.mckenna@windriver.com>
Authored-By: Jason McKenna <jason.mckenna@windriver.com>
Co-Authored-By: Scott Little <scott.little@windriver.com>
Story: 2003906
Task: 27974
2019-02-05 15:49:12 -05:00
Zuul 59bd941ad3 Merge "Adding spec: Ansible bootstrap deployment" 2019-01-24 19:11:01 +00:00
Tee Ngo a76f381204 Adding spec: Ansible bootstrap deployment
Proposing specification on how the bootstrap and configuration of the
initial host can be orchestrated by an Ansible playbook.

Story: 2004695

Change-Id: I895768eae975f2b6a880e82db2c0d9e452f8099c
Signed-off-by: Tee Ngo <tee.ngo@windriver.com>
2019-01-10 13:42:29 -05:00
Kristal Dale 1161e686ec Clean up and standardize landing pages
doc index.rst:
1. Correct heading levels (impacting side nav and correct rendering of content)
2. Remove "Indices and Tables" section: genindex page not used, move search link to intro sentence.

spec instructions.rst:
1. Update page title to be consistent w/ incoming link text (so that link with text "How to submit a spec" goes to a page titled "Submit a Spec")
2. Add section header to first list on page

Change-Id: Ic3071bcf1c8d152c68d6735f08bb97e768aa944f
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-12-28 10:15:46 -08:00
Zuul 632037e512 Merge "Move CEPH persistent storage backend for Kubernetes to 2019.03/approved" 2018-12-15 02:33:24 +00:00
Ovidiu Poncea eedea8387b Move CEPH persistent storage backend for Kubernetes to 2019.03/approved
Due to process change move spec to 2019.03/approved

Change-Id: I39defa380f3a6a74b71edf77a3bd38e18cec7938
Signed-off-by: Ovidiu Poncea <ovidiu.poncea@windriver.com>
2018-11-27 08:16:03 +02:00
Greg Waines 1ed103250b Create Spec: StarlingX - Distributed Cloud - Synchronized Keystone
As agreed upon within Edge-Computing meetings, this
specification proposes an additional Identity solution for the
Edge Reference Architecture; i.e. a 'Synchronized Keystone'
solution.  This solution addresses Edge-Computing Use Cases
where full autonomy is required on network connectivity loss
but without the overhead of running an Identity Provider (IDP)
presence at each Edge Cloud site.

Change-Id: Ie60c324e01c23b262336ce24c481e359c5bd61d7
Signed-off-by: Greg Waines <greg.waines@windriver.com>
2018-11-26 14:52:55 -05:00
Zuul d7732f0238 Merge "Variable Substitution Initial Specification" 2018-11-06 19:32:35 +00:00
zhipengl 5676cbd92b Adding spec: refactor init/config related non-openstack patches.
For RPM patches related to adding or changing StarlingX specific systemd
service files, configuration files or other types,
1)if they are not overwritting files already delivered by the upstream RPM,
  refactor and have an specific config rpm that delivers the new file instead
  of original patch.
2)if they need to change files delivered by the upstream RPM, use puppet to
  change it instead of original patch.

Story: 2003768

Change-Id: I3112ecebaec2e8e1531922e87036209f6acc61dd
Signed-off-by: zhipengl <zhipengs.liu@intel.com>
2018-10-31 02:13:02 +00:00
John Kung 7569733926 Create Spec: Decouple System/Service Configuration from System Inventory
stx-config project sysinv currently consists of Inventory and
Configuration components.  Inventory includes Host Management.
This creates the spec to decouple Inventory components from System,
Storage, Service Configuration and management.

Story: 2002950
Task: 22952

Change-Id: I1a4d3b4e2191a14a7919425efe4fcec58de096b3
Signed-off-by: John Kung <john.kung@windriver.com>
2018-10-30 11:21:18 -04:00
Zuul 8317f38ade Merge "Spec: Enable External Mirror for the StarlingX Community" 2018-10-30 00:26:13 +00:00
Ovidiu Poncea ce01b950f5 Adding spec: CEPH persistent storage backend for Kubernetes
Change-Id: Ie42923fbcc64fba89cb00b3746bff92bf9dbb99a
Co-Authored-By: Irina Mihai <Irina.Mihai@windriver.com>
Signed-off-by: Irina Mihai <Irina.Mihai@windriver.com>
2018-10-29 13:28:46 +02:00
Zuul df9eb824bf Merge "Spec for kubernetes platform support" 2018-10-26 22:48:05 +00:00
Zuul 17d66f1847 Merge "Adding spec: Standardize makefiles for multi-os support." 2018-10-26 00:28:29 +00:00
Zuul e883247810 Merge "Containerization: Helm Chart Override Generation" 2018-10-25 23:54:18 +00:00
Erich Cordoba 1621c047df Adding spec: Standardize makefiles for multi-os support.
Change-Id: I6aafb72d908ded0bbb1a8662151e246194e4c302
Signed-off-by: Erich Cordoba <erich.cordoba.malibran@intel.com>
2018-10-25 14:16:24 -05:00
Robert Church e2a7fbf95d Containerization: Helm Chart Override Generation
Proposing specification on how Helm chart overrides will be managed in a
StarlingX deployment.

Change-Id: Ibfce3c39742511b4108205612e979dcc81f9beb9
Signed-off-by: Robert Church <robert.church@windriver.com>
2018-10-25 13:59:31 -04:00
Saul Wold dcdd5f852b Variable Substitution Initial Specification
This specification address the current usage of hard-coded system paths
in the Starlingx Services (flock).

Change-Id: Ia6060e88d8aada5d74530680ef25476542aa03b4
Signed-off-by: Saul Wold <sgw@linux.intel.com>
2018-10-25 08:17:29 -07:00
Zuul c600700b30 Merge "Add spec for armada integration" 2018-10-25 14:28:51 +00:00
Al Bailey 74073a2835 Spec: Enable External Mirror for the StarlingX Community
Proposed spec for hosting an external mirror for StartlingX
community.

Change-Id: I9708b4ebe04c26496e0e4b49b557073df43912e0
Co-Authored-By: Scott Little <scott.little@windriver.com>
Signed-off-by: Al Bailey <Al.Bailey@windriver.com>
2018-10-24 14:19:27 -05:00
Robert Church f2a756f493 Add doc8 linter to tox for spec validation
This will check the specs for the following when running tox:

linters runtests: commands[1] | doc8 specs/
Scanning...
Validating...
========
Total files scanned = 7
Total files ignored = 0
Total accumulated errors = 0
Detailed error counts:
    - CheckCarriageReturn = 0
    - CheckIndentationNoTab = 0
    - CheckMaxLineLength = 0
    - CheckNewlineEndOfFile = 0
    - CheckTrailingWhitespace = 0
    - CheckValidity = 0

Also fixes:
 - One long line violation in instructions.rst
 - DOS CRLF formatting of
   containerization-2002840-local-docker-registry.rst

Change-Id: I73e1c87401156fe1fd52ab2b5460201f559c6284
Signed-off-by: Robert Church <robert.church@windriver.com>
2018-10-22 20:34:58 -04:00
Zuul 606c09eab8 Merge "Spec for system deployment of containerized openstack infrastructure" 2018-10-22 21:50:55 +00:00
Zuul 158a757057 Merge "Adding spec for local Docker registry" 2018-10-22 21:43:20 +00:00
Chris Friesen fbdafb8d3d Add spec for armada integration
This story will build on the basic Kubernetes/Helm support, making use of the
'airship-armada' project to provide a higher-level management of the
multiple helm charts which together comprise an application such as OpenStack.

Change-Id: Idfb2da7734a598d296456c236686e61e62b5d257
Story: 2003908
Task: 26791
Signed-off-by: Chris Friesen <chris.friesen@windriver.com>
2018-10-19 10:52:07 -06:00
Bart Wensley 65f6ef6324 Spec for kubernetes platform support
Submitting the following spec for review:
containerization-2002843-kubernetes-platform-support.rst

Change-Id: I86d28e38fe36572d5909eb2a36faa4aea18c6df8
Signed-off-by: Bart Wensley <barton.wensley@windriver.com>
2018-10-19 07:59:00 -05:00
Jerry Sun 95c3c496d6 Adding spec for local Docker registry
As part of containerization, adding the local Docker registry spec

Task: 27498
Story: 2002840

Change-Id: I9a59a1ec1f9a40d0da3d79597026216637c43376
Signed-off-by: Jerry Sun <jerry.sun@windriver.com>
2018-10-17 11:05:38 -04:00
Robert Church 08ff127d4b Fix spec template formatting
No change to any verbiage here. Just comply with the following
formatting requirement in the template:

*  Please wrap text at 79 columns.

Change-Id: I02871d2d999ccd6063720e66b6de0cb3b666018d
Signed-off-by: Robert Church <robert.church@windriver.com>
2018-10-17 01:25:00 -04:00
Bart Wensley 9f239ab5fe Spec for system deployment of containerized openstack infrastructure
Submitting the following spec for review:
system-deployment-of-containerized-openstack-infrastructure.rst

Change-Id: Ic4bf44d2324b9c1f5d595daa19f260b612f4dc48
Signed-off-by: Bart Wensley <barton.wensley@windriver.com>
2018-10-16 08:31:08 -05:00
Chris Friesen f7c04656d8 Add per-release subdirectories to avoid confusion
Eventually we'll have multiple releases, so let's create per-release
subdirectories such that we can track which specs were approved/implemented
in each release.

Change-Id: Iadbd4a73701d01a5c88ab5414e2b607eab779357
2018-10-15 14:42:19 -06:00
Al Bailey 415b3486f5 Adding the first spec: docker-image-generation
Removing the placeholder which was only present until a spec
was uploaded.

Including the spec for generating docker images to be
used by containerization

Change-Id: Ib39ccbc893bb4078b4b1cbf5d505b489ced5ed01
Authored-By: Don.Penney@windriver.com
Co-Authored-By: Al.Bailey@windriver.com
Signed-off-by: Al Bailey <Al.Bailey@windriver.com>
2018-10-12 12:01:55 -05:00
Frank Miller 1ed5fe0440 Updating the spec naming convention
Updating the spec naming convention in instructions.rst
and STX_Example_Spec.rst

Change-Id: I2f414bafe6efa6bea7604e9423e88c1932a50a7a
Signed-off-by: Frank Miller <frank.miller@windriver.com>
2018-10-09 15:57:03 -04:00
Zuul 76857eefd5 Merge "Update to STX_Example_Spec.rst" 2018-10-09 13:21:17 +00:00
Dean Troyer b3d7cc4431 Remove old template
Also update the instructions

Change-Id: Ib88a67a5eb63e8025ed66ce1563061bd18892e3f
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-04 14:55:34 -05:00
Dean Troyer a00f7d2bb7 Add specs publish job
Also set the theme to alabaster until starlingxdocs theme
is available in a released openstackdocstheme module.

Also makes a change to the sample spec header to format
the index page properly.

Change-Id: I960e49483cd7f17aec5cc38dcaa634c19ad8789a
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-03 22:30:34 -05:00
Frank Miller 82783efc19 Update to STX_Example_Spec.rst
This commit updates the STX_Example_Spec.rst to update the proposed
file naming convention to be used when creating a new spec.

Change-Id: I29fc00048e356520e92852d13c66374fd790816e
Signed-off-by: Frank Miller <frank.miller@windriver.com>
2018-10-03 16:48:31 -04:00
ijolliffe 476398fd15 New Template for StarlingX Specs
This document is intended to form the basis for new specs for the
StarlingX project.  The template is based on the Stein Nova Spec
template, which has been refined over time, and provides an
excellent foundation. The template is long, but, there are optional
sections.Overall, this captures the key elements of a spec that will
help the project define new technology directions.

Change-Id: Icf5177289ca4001dad0057e90000ddfaf6cce051
Signed-off-by: Ian Jolliffe <ian.jolliffe@windriver.com>
2018-10-02 10:10:58 -04:00