starlingx/docs
Code Issues Proposed changes

Initial commit for guide reorg - upcoming release

Browse Source 
- Migrated reorged content from wiki
- Naming, title, and capitalization consistency, minor rewording in sections
- Set up includes to reuse common content across pages
- Introduction: remove 'openstack users' and 'kubernetes users'
- Consolidate term definition into Key concepts page
- Archive R1, move R2 to current releast, set up for R3
- Remove stub pages for duplicate content, or content deferred to R3
- Rework intro and contribute pages for better readability
- Split Key concepts into two pages: Terms and Deployment Options
- Pass for grammar, punctuation, licensing, etc.
- Pull streamlined intro content into R2 install guides (from prev version)
- Added R2 release note page
- Update links to projects/project names to remove the "stx-"
- Add instructions for creating a bootable USB

Story: 2006315
Task: 36046

Change-Id: I38656fd382d1d9cf2969812c548fb7b2dc9dd31e
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale
2019-08-21 11:27:07 -07:00
committed by Abraham Arce
parent f7bce640c8
commit 5676e4fda4
71 changed files with 5611 additions and 6685 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
doc/source/introduction/consuming.rst
View File

@@ -2,57 +2,49 @@
Consuming StarlingX
===================
StarlingX is ready for you to use today. However limitations exist
regarding what you can do with the
open source software. Features of the software
like Secure Boot and live Software Update are not fully enabled by
the community.
StarlingX is ready for you to use today. However limitations exist regarding
what you can do with the open source software. Features of the software
like secure boot and live software update are not fully enabled by the community.
The community does not provide signed software images, which are needed
to enable features that depend
on signed images to implement Security features.
Providing signed images typically are the responsibility of
commercial vendors or the users themselves.
As such, the following are
three ways in which you can consume StarlingX.
The community does not provide signed software images, which are needed to enable
features that depend on signed images to implement security features. Providing
signed images is typically the responsibility of commercial vendors or the users
themselves. As such, the following are three ways in which you can consume StarlingX.
---------------------------
Deploy the open source code
---------------------------
You can use the open source software directly. Our community partner
CENGN has an archive containing ready to run
ISO images of the current StarlingX releases and daily builds.
You can use the open source software directly. Our community partner CENGN has
an archive containing ready to run ISO images of the current StarlingX releases
and daily builds.
As previously mentioned, these images are not signed
and thus do not support Secure Boot or live Software Updates. You can also
build your own images of course.
As previously mentioned, these images are not signed and thus do not support
secure boot or live software updates. You can also build your own images.
The StarlingX community recommends that anyone looking to deploy
the open source software use the release images, which have been
tested and validated by the community. Developers
looking to work against the tip of the source trees would
The StarlingX community recommends that anyone looking to deploy the open source
software use the release images, which have been tested and validated by the
community. Developers looking to work against the tip of the source trees would
typcally use the daily builds.
---------------------------------------
Deploy an internal version of StarlingX
---------------------------------------
If you are part of a company, the company itself can create
a team to create their own version of
StarlingX for the company. Such a team could do
acceptance testing of the open source software, customize it as
needed, sign their own internal images, and use the features
in StarlingX to enable Secure Boot and to develop and deliver live
Software Updates (patches) to their internal users.
If you are part of a company, the company itself can create a team to create
their own version of StarlingX for the company. Such a team could do acceptance
testing of the open source software, customize it as needed, sign their own
internal images, and use the features in StarlingX to enable secure boot and to
develop and deliver live software updates (patches) to their internal users.
-------------------------
Deploy code from a vendor
-------------------------
You can also consume a commercial vendor's StarlingX-based
product or solution. Vendors can provide signed images and
signed Software Updates. They can add features or content to
the open source software. They may provide other services such
as technical support.
You can also consume a commercial vendor's StarlingX-based product or solution.
Vendors can provide signed images and signed software updates. They can add
features or content to the open source software. They may provide other services
such as technical support.
The StarlingX community
expects several vendors to provide StarlingX-based products
The StarlingX community expects several vendors to provide StarlingX-based products
and solutions. We hope to see more as our community grows.