updated telempostd description, kept at high level, will provide more detail in other documentation. Also changed |CL| to |CL-ATTR| for first instance.
- remove leading './' for step 4 of Image content validation
- remove important note for step 4 of Image content validation
- correct file name for step 1 of Update content validation from Manifest.sig to Manifest.MoM.sig.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Revises headers to follow convention per collab guidelines
- Revises CL in accordance with new branding
- Removes `$` for CLI prompts and corrects code-blocks to bash
- Adds sentence in para 2, `download it here`, a previously unused link
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
this commit removes the *png files that are no longer used
for the flatpak tutorial.
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
This commit updates the Flatpak tutorial to make use
of the gnome-software application and keep the command
line setup as well.
LibreOffice flatpak repository changed to Flathub.
This commit updates the instructions to install it
as documented in https://www.libreoffice.org/download/flatpak/
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
- Substitutions
- Python config file
- Replace hard coded product name in page heading with sub on CL doc landing page
- Replace hard coded product name with sub in system-requirements
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
* Changed directory name for mixer workspace where the workspace is given
a path and further in the document the workspace path different, this
leads to an error when using correct procedure specified in document.
This change uses the same directory path.
* Fix for a typo where the correct default value for a configuration
file name is incorrect and when copying value from document will lead to
errors when following proper procedure specified in document.
Signed-off-by: Alex Jaramillo <alex.v.jaramillo@intel.com>
- Removed quotes on terms, italicized first use of new term
- Removed multiple, redundant reference to full CLOSIA text, in favor of shorter, more readable 'Clear Linux'
- Minor edits to Bundles section, to make non-user type specific
- Added heading to mixer tool paragraph, link to concept page (so sections mirror order of intro paragraph, clarify topic as separate from Update speed section)
- Remove commands to enable/disable (we don't focus on this level of detail anywhere else in this page - it is about the concepts and links to details where needed)
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Adds notes to swupd-search to clarify scope of functionality
- Revised develoepr-workstation table and copyedits for clarity.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
- Reorder inclusion of swupd-search in developer-workstation
- Add swupd-search to toctree of maintenance.rst
- Revise FAQs in swupd-search
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
- Replace "Install VirtualBox" with Prerequisites
- Add new hyperlink to troubleshoot enabling VT on IA (previous unhelpful)
- Replace section "Linux Guest Additions" with note on LTS integration.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
- Updated intro, emphasis on introducing CL update compared to traditional update
- Removed the (repeated) definition of the traditional wya, already used elsewhere
- Removed intro paragraph heading to be more consistent with layout of other concept pages
- Added link to bundles page from bundles section
- Moved 'using swupd' link to Updating section (from bottom of page where it came after mixer discussion)
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Revising clear-linux top-level TOC
- Adding a clear definition of what a guide is
- Adding a clear definition of what a tutorial is
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
- Retitles bare metal 'manual' for parallelism
- Retitles bare metal 'automatic' for parallelism
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
- Simplifies and combines two mix workflows at start
- Fixes Sphinx syntax
- Replaces incorrect link to web server in section CONTENTURL, VERSIONURL
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
-Add command to search for bundles and reference to online bundle-list
- Add swupd help as additional information
- Reformat commands with switches but no parameters as commands instead of code-blocks
The autoupdate subcommand has been around for a very long time now and
should be used instead of the systemctl masking commands.
Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
Add information for latest functionality of the mixin package
subcommand. The --bundle flag allows users to specify the name of the
bundle they add their package to.
Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
The /usr/share/mix/rpms directory is no longer used by mixer/mixin.
Instead use the appropriate default /usr/share/mix/local-rpms directory
because this is where mixer looks for local RPMs when initializing the
local repository.
Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
Reword and rewrite the swupdaddpkg.rst documentation for the new mixin
tool and outline new features. The mixin tool is meant to replace
swupd-add-pkg and provide a new capability of adding remote RPM
repositories to the local mix.
Signed-off-by: Matthew Johnson <matthew.johnson@intel.com>
Updating virtual box installation document to reflect latest LTS
kernel version (4.14) released on Nov 2017. New kernel version info
updated in two places. fixed minor numbering typo and syntax.
- Remove status column in bundles.html table, omitting active, wip
- Use `swupd bundles-list --all` to validate all current bundles, pundles
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
- Changes all input commands to use 'bash'
- Simplifies verbiage on swupd bundle-add os-clr-on-clr
- Corrects word-wrap to 78
- Corrects formatting on Note, lines 91-96
- Omits unused URI, as result of PR 124
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
- Corrects grammatical errors and simplifies instruction for various installation methods.
- Revises bare-metal-manual-install to correct errors and for readability.
- Revises cgdisk-manual-install; omits fig. 16, then directs user to bare-metal-manual-install.
- Revise virtualbox.rst, first two paragraphs for conciseness; omits prefixes to commands
- Revises instruction in Bundle Selector. Fixes Figure 15.
- Corrects erroneous link in first para to bare-metal-manual-install.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
Files: image types; download verify uncompress for Linux, macOS, and Windows
Edits for branding and format. Removed $ prompts.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
Reordered text and included CL details in multi-boot.rst.
Renamed “reset-bl” file references to “restore-bl” for clarity.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
I added a note that might confuse new users when following the getting started sequence download, import vmware VM->enable user space. The linux error will not indicate that the hard drive isn't big enough. The link did not render in the preview for some reason so edit it to conform with your relative links convention and build before pulling.
Added Prerequisites section.
Added sudo -s as first command and deleted sudo from other commands.
Edited text for active voice and consistency between steps.
Removed gerunds in headings.
Changed figure captions to remove gerunds and differentiate.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
to your VNC session, includes steps 1-2 for each use case. Makes configuration of RealVNC optional
section--instead of note.
Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
Modified topic title. Replaced # with sudo.
Removed ini role, added bash role to user entry code blocks.
Removed duplicated external link.
Edited text for active voice and consistency between steps.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
Modified topic title, heading text, and heading levels.
Deleted prompt character. Replaced # with sudo.
Corrected links to external webpages.
Edited text for active voice and consistency between steps.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
Deleted prompt character. Replaced # with sudo.
Assigned bash role to code blocks with user entries.
Edited text for active voice and consistency between steps.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
Deleted prompt character. Replaced # with sudo.
Assigned bash role to code blocks with user entries.
Edited text for active voice and consistency between steps.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
The rewrite includes:
Explicit commands for important options.
Use of lists to improve the clarity of the configuration variables content.
Removal of command prompts to enable DBT.
Consistent use of terminology.
Use of concrete examples to improve the clarity of the commands.
Improved content flow and navigation with linked workflow overviews.
Added cross-references.
Removed ambiguous relative pronouns and punctuation.
Removed passive voice whenever possible.
Changed verbs to present tense for consistency and style guide compliance.
Optimized headings for search engines.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Added |CLOSIA|, removed incorrect option roles, added envvar role,
removed XML language in code blocks, and minor text edits.
Signed-off-by: MCamp859 <mary.camp@ptiglobal.net>
This patch updates the documentation to comply with all of the new changes
Mixer 4.0 introduces:
- Many changes to the bundle lifecycle. It introduces
the concept of "local" and "upstream" bundles, and several new commands
to work with them.
- The new, native implementations of swupd-server
and the bundle-chroot-builder tool, both still in experimental
mode behind optional flags.
- New default values for mixer init
Signed-off-by: Kevin C. Wells <kevin.c.wells@intel.com>
* In the "preconf" doc -> Create and configure -> step 10, I changed "When you attach the pre-configured |CL| VMware image, VMWare removes the default virtual disk making this setting irrelevant" to "The disk settings do not matter at this stage because you will remove the default virtual disk and attach a pre-configured Clear Linux VMware image at a later step" because the former implies that VMware will do it automatically, but in fact, the user will manually remove the default virtual disk.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
Drastically simplified the language used and fixed grammar, spelling,
and style issues.
Fixed the content flow. Particularly how the screenshots are handled.
By fixing how the screens were introduced, the steps could be simplified to
a single level. This change provides a much better experience for readers.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
- Changed the names of the images to follow naming convention.
- Re-used content from the "download-verify-uncompress" docs.
- General language fixes.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
Signed-off-by: Bun K Tan <bktan1@bktan1-mac08.jf.intel.com>
This latest version of the VMware player improved document was merged with the latest main branch and will be in a different branch than the last pull request, which I will remove.
Updated with feedbacks from Ianeta.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
Update
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
Updates...
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
1) Changed the title to "Run Clear Linux as a VMware Workstation Player guest OS". I think "Use VMware Player" is too generic.
These are changes based on Tom's feedback:
2) Added minimum disk size info.
3) Added minimum memory info and a screenshot.
4) Added file type info for .vmx file in Windows.
5) Added blurb on how to verify checksum for Windows.
-----
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
Corrected screenshot for figure #19.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
>>> 2017-11-17
- Converted figures substitution to inline.
>>> 2017-11-21
1) Added brief intro to what VMware Workstation player is.
-----
Simplified language for clarity. Changed passive voice to active voice.
Modified code blocks' markup to future-proof content for Document Based
Testing.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
- Made the "parted" tool warning code-block look awkward.
- Fixed the "parted" tool note.
- Fixed the "Figure 1" statement under "parted tool" section.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
The default data directory for Apache is /var/www/html
in the latest version (tested on VERSION_ID=20490), instead
of /usr/share/httpd/htdocs as specified in the web-server-install
tutorial. This causes several inconsistencies in the "Change the
Default Configuration and Data Directory" section.
This commit updates the steps to configure a different data
directory for demostrative purposes (/var/www/tutorial) as the
proposed one (/var/www/html) is currently the default value.
As the rest of the document and the WordPress server tutorial
refers to /var/www/html, it's also necesary to add aditional steps
to return the configuration back to the original values to leave
it ready for the user to be able to follow the next steps in this
and the WordPress tutorials.
Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>
In the "Change the Default Configuration and Data
Directory" section, the curly quotation marks in the
httpd.conf example cause service start errors when
the text is copied and pasted over directly to the new
httpd.conf file, as part of following the section's
steps.
This commit replaces the curly double quotes with straight
double quotes to correct the wrong behavior.
Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>
The correct default path for httpd.conf is /usr/share/defaults/httpd
instead of /etc/share/defaults/httpd, as specified on the
web server install tutorial.
This commit corrects it in the document.
Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>
The first two screenshots in the web server install tutorial
don't correspond to the default configuration in the latest
version of the Apache and PHP servers (as tested on
VERSION_ID=20490).
This commit updates both screenshots and the text that refers
to them in the document.
Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>
Updating the documentation for mixer to account for recent changes,
and to better clarify some concepts. This is to coincide with an
upcoming release of mixer, in which several important changes will
be introduced.
1) The mixer CLI has been rewritten, supporting POSIX-style flags
and a modern command layout. This is a breaking change, as commands
and flags have been renamed.
2) The initialization steps for mixer have been further automated,
so the documentation has been updated to account for the new,
simpler approach.
3) Documentation has been added for the recent command for
automating the addition of bundles to a mix.
4) The tool now handles caching upstream CLR bundle definitions
in a more automated way, and so the 'mixer get-bundles' command
(and its corresponding documentation section) has been removed.
Signed-off-by: Kevin C. Wells <kevin.c.wells@intel.com>
- Reworded the "minimum memory" setting when using the installer ISO for the "install" doc.
- Added a phrase on enabling UEFI support in the "preconfigured" doc at the beginning section of "Create and configure a new VM".
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
Took out all cross-references to documents not yet merged. Cleaned up the
include directives and changed the image types include to a simple
cross-refernce. Lastly, I rebased the entire branch to remove conflicts.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2) Restart numbering of the figures for the vmware-esxi-preconfigured-cl-image.rst.
3) Reused "Types of Clear Linux images", "Verify the integrity of the Clear Linux image", and "Uncompress the Clear Linux image" content.
4) Removed labels and references to them.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2) Added minimum memory size (with screenshot) info for Method 2.
>>> 2017-11-17
Converted figure substitutions to inlines.
>>> 2017-11-21
1) Added brief intro of what ESXi is.
2) Updated the "Download the latest Clear Linux image" section to tell which image to download based on the "Method" type.
3) Added a "Note" to the beginning of "Verify" and "Uncompress" sections to say that the command-line examples reference an "installer ISO" and to substitute as needed.
4) Added reference to the "Workstation" version of VMware in the intro.
5) tagged the "Download", "Verify", and "Uncompressed" sections so they can be re-used in the VMware Workstation doc.
>>> 2017-12-05
1) Moved the "Download", "Verify", and "Uncompress" sections under "Method 1".
2) Re-using the "Types of images", "Verify", "Uncompress" modules from Guides/Maintaince/download-image.rst.
>>> 2017-12-07
1) Made changes based on feedback.
2) Reused content from Guides/Maintenance/download-image.rst.
3) Created labels for each section and ref'ed them at the beginning of each "Method".
4) Updated Figure 26.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
1) Fixed language per feedback.
2) Renamed Rufus-figure-1.png, Rufus-figure-2.png, Rufus-figure-3.png, 7zipwin.png to approved figure naming convention.
3) Fixed minor markup issues.
Sgne-off-by: Bun K Tan <bun.k.tan@intel.com>
Several include directives were unnecessary since a simple cross-reference
was more appropriate in terms of content architecture.
Simplified the includes employed to enhance maintainability.
Created duplicate figure file to enable reuse.
Fixed headings for consistency.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
On 2017-11-30:
--------------
1) Created the download-image.rst file in the Guides/Maintaince. This is a hidden file and not visible under the Maintenance tree. This talks about types of Clear Linux images, how to verify checksum, and how to uncompress for Linux, macOS, and Windows. This is the base for other docs such as the bare-metal, live, bootable USBs (Linux, macOS, Windows), VMware docs...
2) Reworked the bootable-usb-linux.rst to re-use content from download-image.rst.
3) Reworked the bootable-usb-mac.rst to re-use content from download-image.rst.
4) Reworked the bootable-usb-windows.rst to re-use content from download-image.rst.
5) Reworked the live-image.rst to re-use content from bootable-usb-linux.rst and download-image.rst.
6) Reworked the bare-metal doc to re-use content from bootable-usb-linux.rst and download-image.rst.
On 2017-12-01:
--------------
1) Updated the types of images list and created a table.
2) Remove references to the old "releases" repo. Users should only use the "image" folder - per engineering.
On 2017-12-05:
--------------
1) Recaptured the 7zip screenshot and made it look better.
2) Added "download-image.rst" to the Guides/Maintenance/maintenance.rst" tree to make it visible.
3) Moved the "Download the latest Clear Linux image" out of the "download-image.rst" and put it into
the "bootable-usb-linux.rst" and tagged it so it could be used by "bootable-usb-mac.rst" and
"bootable-usb-windows.rst".
On 2017-12-07:
--------------
1) Changed the "Types of images" list Guides/Maintenance/download-image.rst to a table format.
On 2017-12-13:
--------------
1) Changed all instances of <> to [] to indicate substitution.
2) Added |CAUTION-BACKUP-USB| in substitution.rst. This is used in create-usb-linux.rst, create-usb-mac.rst, create-usb-windows.rst.
3) Deleted download-image.rst and created 3 new docs, one for each OS: download-verify-uncompress-linux.rst, download-verify-uncompress-mac.rst, download-verify-uncompress-windows.rst.
4) General fixes based on feedback.
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
This document added screenshots without using the figure directive.
Thus, the captions did not have the correct CSS class.
I applied the figure directive and removed the substitutions.
The captions now have the appropriate CSS class in HTML.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Set requirements to reflect those instructions that gcc will use when
building for the westmere target architecture as that is how Clear
Linux is currently being built.
Added explicit instructions on how to contribute via GitHub, naming conventions
for all files, and explicit markup instructions for figures, links, and headings.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Rename all .png files to appropriate file-name-fig# and update the .rst
files to call correctly. Also included minor updates to text
Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
Ciao has created their own content in their repos. Therefore, this
content is redundant and causes confusion.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The Function Multi-versioning tutorial content was provided by Victor Rodriguez.
This version has been edited and the markup fixed to comply with the
documentation repo's guidelines.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Beyond adding those two sections, some commands were updated and other minor
issues were fixed.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Altered the enable-user-space to include the initial step of creating
a user. Also added "Create a new user" to the list of capabilities after
installation. I changed the heading of `enable user space` to reflect changes.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
Updated get-started.rst to add references to bare-metal-* files
Update cross-reference in bare-metal-manual and cgdisk-manual-install
files. Fixed minor issues within content
Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>
changes recommended by the engineering team to correct the repair description and removed final step to create a userid since that is duplicated in the enable-user-space section.
Makes an end-to-end auto bare-metal doc with a branch to manual install.
Post installation tasks separated and moved to maintenance guide.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
Cleans up the bare metal install steps prior to the manual vs auto
decision with new screen captures. Then, forks to provide two ways
to install on bare-metal.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
This section contains all the guidelines, rules, examples, and templates needed
to contribute content to the Clear Linux project. The mechanics on how to use
Git to contribute the content will be added in the future.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This update to the table of available bundles makes the HTML table a
separate file to make updating easier. This is necessary to automate the
update process in the future.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Creates new bootable-usb options for macOS and windows. Changes
live image and bare metal installs to include modularized options.
Removes hard-coded numbering in bare metal install. Updates toc
trees where appropriate.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
Content files are moved, renamed, and relabeled to fit into get started,
concepts, guides, tutorials, and reference sections. Toc-trees were
changed where apropriate and section descriptions were provided.
Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
This tutorial guides users through the process of installing other operating
systems alongside Clear Linux.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Updated the release version of Docker compatible with the runtime. Removed the
release number of the Clear Containers to avoid having to update it every week.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Add additional steps to change the default Apache DocumentRoot to /etc/www/html by adding additional .conf files in /etc/httpd/conf.d and changing all references to this new DocumentRoot directory.
Use "mkdir -p" to avoid failure when some part in the middle of the
path doesn't exist (this is currently the case with a freshly
installed Clear 16820).
Add instruction to reload the systemd configuration, otherwise the
OPTIONS line won't be used and the subsystem won't work.
Signed-off-by: Caio Marcelo de Oliveira Filho <caio.oliveira@intel.com>
The website does not support important notices, therfore the notice had to
change to a note.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Includes kernel in gs contents page introduction and adds
compatibility check to doc-tree.
Improves introduction to compatible kernels and bundles.
Updates links to avoid hard coding.
Moves bare metal install from tutorial to getting started guide.
Removes repeated and/or out of date information about VM and BM
installations and hardware compatibility check. Adds reference
tags for future documentation.
The machine learning tutorial showcases how to install, configure, and run a
Jupyter notebook on Clear Linux with the MNIST example.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
To verify the Manifest.MoM, the signature of the Manifest.MoM should be compared with the Swupd certificate, not the Clear Linux certificate. Also, adding a section for manually validating the Swupd certificate so that it matches the section for manually validating the Clear Linux certificate. Making the distinction between the Clear Linux certificate and the Swupd certificate more clear.
Documentation recommends the user to access swupd the man page for
further details, however user may not have /usr/bin/man command
installed, so document that he/she needs to install 'sysadmin-basic'
bundle prior to actually accessing the man-page.
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
This commit adds general information about the kvm-host
bundle content and how to enable/start some services
that may be required when this bundle is installed.
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
Adjusted guide to use numbered process steps, removed invalid :caption:
parameter on code-block sections, plus some clarification edits and
80-character line length formatting
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The page was using bad ReST reference stricture producing broken links.
This commit uses ReST cross reference by labels.
Signed-off-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
Makefile is rebuild with simple targets to point to source directory.
Now the users can use "make" or "make html" at root repo path and the
html documentation is built.
A warning is showed when compiling the documentation:
WARNING: html_static_path entry '/home/git/clear-linux-documentation/source/_static' does not exist
After documentation restructure, the _static directory is no more needed.
This commit comment out html_static_path in config.py, and the warning
is not showed.
When compiling documentation a warning message is showed:
WARNING: The config value `html_add_permalinks' has type `bool', defaults to `str'.
The documentation from http://www.sphinx-doc.org/es/stable/config.html
said to set it to None or the empty string to disable permalinks.
Now it is set to empty string and the warning disappear.
Openssh update
Updates the content based on the introduction provided by @ahkok.
Edits the text for clarity, grammar, and consistency.
See merge request !163
Os core update
Updates the content with a new introduction provided by @ahkok.
Edits the text for clarity, grammar, and consistency.
See merge request !164
Total restructure
This is a major overhaul of the entire documentation.
It introduces:
* One section per Clear technology.
* A new simplified navigation.
* Standard use of labels.
* Decentralized figures.
* A filename convention.
* Minimal content cleanup.
See merge request !162
Total restructure
This is a major overhaul of the entire documentation.
It introduces:
* One section per Clear technology.
* A new simplified navigation.
* Standard use of labels.
* Decentralized figures.
* A filename convention.
* Minimal content cleanup.
See merge request !162
This restructure organizes the content into three sections, one per
technology. The content was left as untouched as possible, however
several directives needed to be standardized in order to implement the
new structure. All filenames follow use dashes-as-spaces and are written
using lower-case. Standard labels for files were implemented using the
filename as the label, thus, content can be cross-referenced without
having to open the file to see the label. Figures were moved to
decentralized folders to enable modularity. The scope of the restructure
as well as the dependencies between the changes required me to do it in
a single commit. Lastly, some cleanup had to be done for the
standardized structure to function properly.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The optional bundles listing is redundant since we already included a
command for all bundles.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Fix kt
As pointed out in a email:
I think this just got merged ... but, I would not write:
"`Intel® Clear Containers`_ project on |CL|."
As Clear Containers, and it's use of this CL, is not bound to CL - it also runs on a number of other distros.
I'd probably just drop the CL reference:
"`Intel® Clear Containers`_ project."
Graham
See merge request !159
As Clear Containers, and it's use of this CL, is not bound to CL - it
also runs on a number of other distros.
I'd probably just drop the CL reference:
"`Intel® Clear Containers`_ project."
Graham
Signed-off-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
Fixed some punctuation. Only bolding ICIS or ISTER when referring to the standalone programs as proper nouns. When used as adjectives to describe the kind of file being worked with, they are not bolded.
Validating Signatures
Updating to make the section for image content validation more clear. Updating to reflect changes in swupd signature validation.
See merge request !155
Performed an edit ensuring parallel content structures, a consistent
tone and style, good grammar and spelling, and trademark
references only on the first instance. Added the name of the bundle at
the begining of each paragraph in the exact form users need to put in
the commands, thus providing a better user experience. Lastly, I fixed
capitalization issues with the links. Although the GitHub repos are
named in lower case, that does not mean the links' text should be in
lower case too.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Simplify the container-bundle page
The bundle description page had too much specific tech details, and needs to be more of an overview and jumping off point. Simplify and improve.
See merge request !148
python-keystoneclient package used to live in the now deprecated
openstack-python-clients bundle and needs to be installed with pip
Signed-off-by: Alberto Murillo Silva <alberto.murillo.silva@intel.com>
Removed the overly familiar style, fixed some minor grammar issues, and
added the appropriate markup where needed.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Additionally, a note was added with a reference to the Docker proxy
documentation to keep that content available.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
I would swear I searched for and fixed these all before, but clearly
this delete command is broken and should have been fixed in the past.
Any invocation that is, eg:
ciao-cli -something
is a sign of a broken command, as all commands now start with, eg:
ciao-cli something
Later option arguments may include a dash, but none of the top level
commands/subcommands do.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
Edited the language to increase readability and clarity.
Implemented the available substitutions and added markup for files and
abbreviations.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Some of the instructions provided code that was not clear or did not work on the latest version of Clear Linux. The documentation is being updated to close these gaps.
Several fixes in vbox and others
* Add one more image to VirtualBox documentation
* Fix images indentation
* Use CL and CLOSIA
* Add a sentence to al VM files to enable VT-x and VT-d.
See merge request !146
The CC bundle page had far too much technical detail, and not enough
overview. Simplify the page by removing the tech info and adding some
overview.
Signed-off-by: Graham Whaley <graham.whaley@intel.com>
Improved the markup to ensure the steps were properly numbered and the
content rendered as intended.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This update includes some info about the bundles have
been deprecated, info about tools for virtual bridges
and replace new steps in use cases.
Signed-off-by: Mario Alfredo Carrillo Arevalo <mario.alfredo.c.arevalo@intel.com>
Mobile menu
Hi Rodrigo this issues has been solved.
- Documentation menu is missing, the bar appears on the footer, but it has no interaction
See merge request !130
Responsive issues
Hi Michael! these are the the solved items
- solved responsive design tables.
- Solved breadcrumb mobile.
- Added margin bottom to "main-content" class, in order to solve overlapping with footer.
- Added a scroll to the class "highlight-console", to improve the view in mobile
See merge request !129
The WordPress installation provides clear instructions to install
WordPress on top of a LAMP web server running Clear Linux. It requires
the completion of both the bare metal installation and the web server
installation tutorials before starting it.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The tutorial provides clear instructions to install a LAMP server using
Clear Linux. LAMP servers are needed for various use cases. The tutorial
can be used for multiple use case tutorials.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The bare metal installation tutorial provides detailed instructions to
install Clear Linux on a bare metal system. This is the first step for
several different use cases and it was written with reusability in mind.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Updates the supported hardware list ensuring compliance with the proper
usage guidelines.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Quite some time back the cli invocation for cluster status was changed,
but the documentation was not. This brings docu back in line with
current behavior.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
Some warnings around ordering of node/daemon startup are no longer
needed as Ciao has enabled connect/disconnect notifications and
cluster formation is more robust nowadays.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
update links for the ciao-deploy page
This pachset updates some broken links in the [ciao-deploy](https://clearlinux.org/documentation/ciao-deploy.html) page in clearlinux.org.
basically 2 changes:
* update broken links from clear-config-management to ciao repo
* remove unused github link
See merge request !126
The `hosts` and `group_vars/all` file links points to the
deprecated ciao content in the clear-config-management on
github instead of the new ciao repository, where the content
was moved to.
This commit changes the broken links to the new location in the
github.com/01org/ciao repository
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
Replaces the placeholder substitutions with the correct Clear Linux
substitutions.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
These steps were updated according to new features
added in OVS 6.1 and DPDK 16.07.
Signed-off-by: Mario Alfredo Carrillo Arevalo <mario.alfredo.c.arevalo@intel.com>
Changed the file structure to allow for easier and better maintenance of
the docs. Files were renamed as needed and following a consistent
convention. Added a index.rst to every folder allowing for partial
builds of the docs. Included content previously left out of the docs
build. The commit also performs minimal housekeeping.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Clear Linux now enables software updates run automatically by
default. This change notifies users of this behavior as well as how to
disable and reenable it.
update ciao deploy with new location of ansible playbooks
This PR changes the documentation to reflect the adoption of the ansible playbooks into the [ciao repo](https://github.com/01org/ciao/)
See merge request !120
Some parts of the Ciao cluster setup document still referenced really old
command line style which no longer works. This commit updates the older
"ciao-cli -command" invocations to the newer "ciao-cli command" (ie: no
'-') style.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
update ciao-deploy page with new container instructions
This merge request updates the instructions on the ciao-deploy page, asking the user to download the ansible playbooks to keep them persistent
See merge request !116
the new ciao-deploy container mounts the ansible
files from the docker host instead of those being provided
by the container. This allows the user to keep a persistent
configuration files, useful when deploy takes place more than once.
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
Remove bundle overview image
The bundle image references both bundles that no longer exist and a layout of bundles that is not used. For now, simply remove the stale image.
See merge request !114
update ciao cluster setup
This change introduces the usage of ciao-deploy container, which contains all the setup
previously done by the user. Now it's only required that the user pulls the `clearlinux/ciao-deploy` container
and start it as described in the instructions.
See merge request !109
Instead of doing a lot of instructions to setup
a deployment machine, we just ask the user to pull
and use a container already setup with all the needed
tools.
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
reword supported hardware section.
Start by specify supported hardware and provide help to determinate
if user's system is available to run clearlinux in a later
paragraph.
See merge request !107
Start by specify supported hardware and provide help to determinate
if user's system is available to run clearlinux in a later
paragraph.
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
update ciao-deploy bundle requirements
Change `os-core-dev` for `c-basic` as we only need gcc.
Change `os-common` for `openstack-common` as the 1st bundle doesn't exists and it really meant the 2nd one.
Please wait for review from @albertom to merge.
See merge request !106
The `os-common` bundle doesn't exists (should be `openstack-common`
instead) and we can use the `c-basic` instead of `os-core-dev`
as it's smaller.
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
Appended /icis/ to bulk_provisioning URLs
Two of the URLs in source/bulk_provisioning.rst pointed to the wrong
URL on the PXE / ICIS server. They now point to the icis subdirectory
where the uwsgi app is running.
Signed-off-by: John Andersen <john.s.andersen@intel.com>
See merge request !103
Two of the URLs in source/bulk_provisioning.rst pointed to the wrong
URL on the PXE / ICIS server. They now point to the icis subdirectory
where the uwsgi app is running.
Signed-off-by: John Andersen <john.s.andersen@intel.com>
Instructions for NATing cluster on network boot
The description of how to construct your network was missing from the
network_boot documentation. This adds instructions on how to
configure the cluster so that the PXE / DHCP server allows traffic
to flow from internal to external networks and vice versa. Without
this the documentation is incomplete as it assumes the user knows how
to set up some kind of networking. By providing this information the
user is able to get a fully functioning cluster up an running biased
solely on this document.
Signed-off-by: John Andersen <john.s.andersen@intel.com>
See merge request !102
The description of how to construct your network was missing from the
network_boot documentation. This adds instructions on how to
configure the cluster so that the PXE / DHCP server allows traffic
to flow from internal to external networks and vice versa. Without
this the documentation is incomplete as it assumes the user knows how
to set up some kind of networking. By providing this information the
user is able to get a fully functioning cluster up an running biased
solely on this document.
Signed-off-by: John Andersen <john.s.andersen@intel.com>
The playbook creates some files when its executed.
The files are:
./certificates directory which contains the certificates used in the cluster
./images directory which contains the os images used in the cluster
./openrc file which contains environment variables to authenticate openstack cli
./ciaorc file which contains environment variables to authenticate ciao cli
Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
The bundles table has updated with current
status of Active / WIP / Deprecated bundles
as of release 10320.
Signed-off-by: Leona <leonax.cook@intel.com>
- The Prerequisite section no longer explains how to
create an ssh-key. Remove a reference to it.
- Specify defaults/main.yml file on each role contains
a full list of available variables that can be used.
- "Start" the deployment rather than "fire" it
- Specify the location of ciaorc file
Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
Update Ciao documentation
This MR updates the ciao documentation
Please do not merge until the team has finished with the review.
See merge request !95
Bulk Provisioning Documentation
I think this should go under the "Advanced" section, alongside the pxe documentation. Wasn't sure how to do that though.
See merge request !93
Docs - sidebar responsive fix
- Fixed responsiveness for sidebar on mobile devices
- Changed in header: Clear Linux Project* to Clear Linux* Project (star was in wrong word)
- Removed unused js code
See merge request !92
create new user `ciao` instead of `admin`
creating `admin` user instruction will fail due to user `admin` is created on the keystone bootstrap process.
We will create a ciao user instead with admin privileges.
See merge request !90
use self-explanatory user/password for the keystone setup
Remove the ``csr`` user, replacing it with a more self-documenting user.
Change passwords to easier-to-understand passwords, avoid duplication
of the very same password for accounts which may confuse the user.
See merge request !89
update ciao-cluster-setup
There are some items that were updated:
- Remove a warning asking to not to start the ciao-controller is no ciao-network node was running.
- Update the configuration example file with new yaml schema changes.
- Use same passwords for the openstack users created to be consistent with the examples provided by the ansible deployment.
See merge request !88
- Add metdata server for CephFS
- Use 'deployment' instead of 'development' node
- Clarify Prerequisites section
- Add a link to each roles default variables
- Add a node that EXT4 is not supported and XFS should be used
Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
Update ciao-cluster-setup
Update with newer usage
- Remove trailing white-spaces
- Rename cnci_agent to ciao-cnci-agent
- Remove options from launchers command line
(options are now fetched from the controller node)
- Update cnci image reference from 7470 to 8260
- Fix broken links
- Create /etc/ciao/configuration.yaml file
See merge request !86
- Remove trailing white-spaces
- Rename cnci_agent to ciao-cnci-agent
- Remove options from launchers command line
(options are now fetched from the controller node)
- Update cnci image reference from 7470 to 8260
- Fix broken links
- Create /etc/ciao/configuration.yaml file
Signed-off-by: Alberto Murillo <alberto.murillo.silva@intel.com>
A "demo" project is needed for the rest of the demostration commands shown.
Something/somebody was pre-creating this automagically in our dev
environment internally, but it needs done manually normally and that needs
documented.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
Given my prior observation of outdated ciao-cli invocations, I did a read
through of ciao-cli related bits and found a number of additional areas
needing updated.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
Quite some time back the command line was modified without reverse
compatibility, and the docu here has bit rotted.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
ClearLinux has simplified their mechanism for CA trust. This nicely
trims a lot of complexity from our ciao documentation.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
The unique thing here versus the upstream documentation is we're describing
a cluster setup where the image, once created, needs to land in a very
specific location.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
An upstream page has the maintained/preferred workflow for setting up a
CNCI. Rather than trying to maintain a duplicate of this, lets minimally
describe what's needed and refer to the upstream documentation point.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
Fix vm virtualbox
On external IRC (freenode) some people are asking to use VirtualBox on ClearLinux.
This PR updates VirtualBox documentation to ensure a proper usage.
This is a P1 issue that afects ClearLinux.
See merge request !83
Ciao certs
We've got a snippet of stale information around adding certificates to a system, and could use some actionable info here to help users get their certs fully configured.
See merge request !82
We removed a section on adding certificates to your browser, yet we do need
info on adding a certificate to the system CA trust. But this varies with
each linux distribution. It's complicated and authoritative information on
the topic is out there in web, so give minimal information to help a
reasonable system administrator on their way.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
Ciao deploy update
Update *ciao-deploy.rst* documentation with current examples in https://github.com/clearlinux/clear-config-management/tree/master/examples/ciao
Changes:
* updated the group_vars/all file with newest example
* deployment added a compute node
* Added the `--private-key=<ssh_key>` instruction when running the playbooks
Please merge once @onmunoz , @albertom , @lmaciasm , @eocardon and @carlosag comment it's all OK with the changes
See merge request !81
This commit removes the --network option that was specified on the various
ciao-launcher example command lines in the previous version of this
document. --network is no longer needed as the role of a given launcher
instance is now determined from its SSNTP certificate.
The instructions for resetting compute and network nodes have been updated.
The --hard-reset option for launcher makes the other steps unnecessary.
Signed-off-by: Mark Ryan <mark.d.ryan@intel.com>
A new image is rsyncing to https://download.clearlinux.org/demos/ciao/
and the documentation needs to reference it. To prevent the need for
these changes repeatedly in the future, we'll soon have things set up
to consume automagically whatever is the latest image.
Signed-off-by: Tim Pepper <timothy.c.pepper@linux.intel.com>
Fix command to create clearlinux bootable USB sticks
It was pointed out that our ``dd`` command to create live usb for clearlinux should not have the ``BS=`` parameter.
This merge request remove the BS=4M parameter from our ``dd`` command.
See merge request !76
This example removes the `bs=4M` part of the dd command using also
a newer installer image (clear-9130-installer.img.xz)
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
as pointed out on IRC:
<arjan> bs= on the dd command line will cause dd to not write the last partial
<arjan> block if the file you're writing isn't a multiple of the size
Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
Clr docs theme v2
Hey there,
This merge request contains all the changes needed to render the new theme of ClearLinux site over the automated documentation.
please take a look over it, ;)
See merge request !57
Pxe
Fixes current doc for iPXE, and adds a new 'step - description' format
These changes were tested on NUCs in Intel's GDC site.
See merge request !48
Staging
Fixing broken links on bundles table (temporary fix until @jchaming and @fenrus75 can correct typos in the Github sources)
See merge request !46
Ignore vim files
With this Merge Request, vim temporary files (*.swp) will be ignored by git, this will avoid adding non-useful files to this repository
See merge request !37
Virtualization Documentation
This patch serie is regarding virtualization software where Clear Linux can be run into.
This brach is based on master due to staging is 6 commits behind master.
This series adds 3 new files, virtualbox, vmware-player and vmware-esxi, and as them are from virtualization and there is already a page talking about virtualization a new section was created, where "running in a virtual environment" document was moved to a new section. All references where updated to create this new section.
See merge request !35
Rename bundle
openstack-telemetry-controller bundle has been renamed to openstack-telemetry since this bundle is installed
on controller nodes as well as compute nodes so a more generic name is desired.
See merge request !34
Remove underscore from update command in swupdate_how_to_run_the_updater.rst
Remove underscore from update command in swupdate_how_to_run_the_updater.rst
See merge request !31
Updated documentation regarding images and installation
The existing documentation is woefully out-of-date. All images are now described, and the instructions for the installer were updated.
See merge request !22
Google analytics code
I've just added the tracking code that will help us to track all the content in order to preserve the SEO for the site.
See merge request !14
Adding gitignore file
Here is just a simmle gitignore which will include the build html files since is't necessary to be tracked.
See merge request !13
This commit gives us a blank slate to implement the theme and be able
to debug it properly.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Merge the fixed and tested theme and index files from staging to master
This latest version of the Sphinx theme solves the following issues:
Redundant titles on the master index page.
Search box placement and functionality.
Left Navigation panel hierarchy and functionality.
In line code markup is now properly rendered.
Ensure that all theme files and all index files are included in the merge. Changes to content files must not necessarily be included.
See merge request !12
Adds the theme files developed by digital properties and modifies
the conf.py to use them. This will allow testing and collaboration.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The modified headings on the index files now work well with the
toctree directives removing the redundant headings on the master file.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Update bundle addition command for clear-containers documentation
Update clr_bundle_add command to install containers-basic
From Clear Linux **release 5050** the instruction to install a
new bundle has **changed from ``clr_bundle_add`` to ``swupd bundle-add``**.
This change updates the instructions to install the
containers-basic bundle to be compatible with the most recent
Clear Linux image released in public (5140 for native/cloud/kvm
and 5210 for container image).
*Please refer to OpenStack documentation (staging or master branch) to check new swupd syntax
usage to install new bundles in a Clear Linux machine.*
See merge request !10
From Clear Linux* release 5050 the instruction to install a
new bundle has changed from clr_bundle_add to swupd bundle-add.
This change updates the instructions to install the
containers-basic bundle to be compatible with the most recent
Clear Linux* image released in public (5140 for native/cloud/kvm
and 5210 for container image).
From CLR release 5050 swupd syntax for adding bundles update and verify
has changed to the following:
clr_bundle_add -> swupd bundle-add
swupd_update -> swupd
swupd_verify -> swupd verify
It was reduced the amount of information provided to the user. The idea is to
only offer minimal information to setup a functional service in order to
highlight those differences that Clear Linux offers.
Signed-off-by: Victor Morales <victor.morales@intel.com>
It was removed several paragraphs in order to reduce the amount of information
available for users. The main idea is to provide only the informaration
required for setting up a functional OpenStack deployment.
Signed-off-by: Victor Morales <victor.morales@intel.com>
It was renamed those files which correspond to supporting services. Moreover, it
was included the instruction to verify fix for installing the binaries of the
bundles.
Signed-off-by: Victor Morales <victor.morales@intel.com>
Staging
MVP documentation has been updated to match with Liberty release of OpenStack.
This series of changes (files) update the documentation:
* index.rst
* openstack_installing_bundles.rst
* openstack_environment-database.rst
* openstack_environment-messaging.rst
* openstack_identity.rst
* openstack_identity-openrc.rst
* openstack_image.rst
* openstack_compute.rst
**Please do review and merge once Issue #1 is closed by Obed N Munoz.**
See merge request !5
Master
This way dev@lists.clearlinux.org becomes a URL of form `mailto:dev@lists.clearlinux.org` upon clicking it, an email client (e.g. outlook, or gmail, or whatever is the default for a user) opens to start writing email.
See merge request !3
<li><p><aclass="reference internal"href="#what-is-cl"id="id3">What is Clear Linux OS?</a></p></li>
<li><p><aclass="reference internal"href="#why-another-linux-distribution"id="id4">Why another Linux distribution?</a></p></li>
<li><p><aclass="reference internal"href="#is-it-a-derivative-of-another-linux-distribution"id="id5">Is it a derivative of another Linux distribution?</a></p></li>
<li><p><aclass="reference internal"href="#can-others-copy-improvements-from-cl"id="id6">Can others copy improvements from Clear Linux OS?</a></p></li>
<li><p><aclass="reference internal"href="#how-often-does-it-update"id="id7">How often does it update?</a></p></li>
<li><p><aclass="reference internal"href="#what-is-the-default-firewall"id="id9">What is the default firewall?</a></p></li>
<li><p><aclass="reference internal"href="#where-are-the-files-that-i-usually-see-under-etc-like-fstab"id="id10">Where are the files that I usually see under /etc like fstab?</a></p></li>
<li><p><aclass="reference internal"href="#does-it-use-the-intel-compiler-icc"id="id11">Does it use the Intel Compiler (icc)?</a></p></li>
<li><p><aclass="reference internal"href="#how-is-software-installed-and-updated"id="id13">How is software installed and updated?</a></p></li>
<li><p><aclass="reference internal"href="#does-it-use-rpms-or-debs-packages-like-other-distros"id="id14">Does it use RPMs or DEBs packages like other distros?</a></p></li>
<li><p><aclass="reference internal"href="#why-does-it-have-a-different-approach-to-software-management"id="id15">Why does it have a different approach to software management?</a></p></li>
<li><p><aclass="reference internal"href="#can-i-install-a-software-package-from-another-os-on-cl"id="id16">Can I install a software package from another OS on Clear Linux OS?</a></p></li>
<li><p><aclass="reference internal"href="#can-you-add-a-driver-that-i-need"id="id23">Can you add a driver that I need?</a></p></li>
</ul>
</li>
</ul>
</nav>
<sectionid="general">
<h2><aclass="toc-backref"href="#id2"role="doc-backlink">General</a><aclass="headerlink"href="#general"title="Link to this heading">¶</a></h2>
<sectionid="what-is-cl">
<h3><aclass="toc-backref"href="#id3"role="doc-backlink">What is Clear Linux OS?</a><aclass="headerlink"href="#what-is-cl"title="Link to this heading">¶</a></h3>
<p>Clear Linux OS is an open source, rolling release Linux distribution optimized for
performance and security. See <aclass="reference external"href="https://clearlinux.org/about">the about page</a>
for more information.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
<sectionid="why-another-linux-distribution">
<h3><aclass="toc-backref"href="#id4"role="doc-backlink">Why another Linux distribution?</a><aclass="headerlink"href="#why-another-linux-distribution"title="Link to this heading">¶</a></h3>
<p>The Clear Linux OS team felt that performance was left on the table with Linux software.
Clear Linux OS takes a holistic approach to improve performance across the stack. We
also wanted to take more modern approaches with OS updates and tooling.</p>
<h3><aclass="toc-backref"href="#id5"role="doc-backlink">Is it a derivative of another Linux distribution?</a><aclass="headerlink"href="#is-it-a-derivative-of-another-linux-distribution"title="Link to this heading">¶</a></h3>
<p>No. Clear Linux OS is a new Linux distribution. It is not a fork and does not have a
<h3><aclass="toc-backref"href="#id6"role="doc-backlink">Can others copy improvements from Clear Linux OS?</a><aclass="headerlink"href="#can-others-copy-improvements-from-cl"title="Link to this heading">¶</a></h3>
<p>Yes, we absolutely love open source reuse and upstreaming improvements.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
<sectionid="how-often-does-it-update">
<h3><aclass="toc-backref"href="#id7"role="doc-backlink">How often does it update?</a><aclass="headerlink"href="#how-often-does-it-update"title="Link to this heading">¶</a></h3>
<p>The Clear Linux OS team puts out multiple releases a week, often releasing two or more
times a day. This rolling release approach allows Clear Linux OS to remain agile to
upstream changes and security patches.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
<sectionid="is-telemetry-required">
<h3><aclass="toc-backref"href="#id8"role="doc-backlink">Is telemetry required?</a><aclass="headerlink"href="#is-telemetry-required"title="Link to this heading">¶</a></h3>
<p>The telemetry solution provided by Clear Linux OS is entirely optional and customizable.
It is disabled by default. If you do choose to enable telemetry, the data
helps the Clear Linux OS team proactively identify and resolve bugs. See the
<aclass="reference internal"href="../guides/clear/telemetrics.html#telem-guide"><spanclass="std std-ref">telemetry</span></a> guide for more information.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
<sectionid="what-is-the-default-firewall">
<h3><aclass="toc-backref"href="#id9"role="doc-backlink">What is the default firewall?</a><aclass="headerlink"href="#what-is-the-default-firewall"title="Link to this heading">¶</a></h3>
<p>Clear Linux OS packages <strongclass="command">iptables</strong> and <strongclass="command">firewalld</strong> as optional
bundles, however, there are no default firewall rules. All network traffic is
<h3><aclass="toc-backref"href="#id10"role="doc-backlink">Where are the files that I usually see under /etc like fstab?</a><aclass="headerlink"href="#where-are-the-files-that-i-usually-see-under-etc-like-fstab"title="Link to this heading">¶</a></h3>
<p>Clear Linux OS has a stateless design that maintains a separation between system files
and user files. Default values are stored under <codeclass="file docutils literal notranslate"><spanclass="pre">/usr/share/defaults/</span></code>.
Clear Linux OS starts with a mostly empty <codeclass="file docutils literal notranslate"><spanclass="pre">/etc</span></code> directory to store user-defined
configurations. See the <aclass="reference internal"href="../guides/clear/stateless.html#stateless"><spanclass="std std-ref">stateless</span></a> page for more information.</p>
<p>See <aclass="reference external"href="https://clearlinux.org/news-blogs/where-etcfstab-clear-linux">this blog post</a> for an
example explaining how this is accomplished with <codeclass="file docutils literal notranslate"><spanclass="pre">/etc/fstab/</span></code>
specifically.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
<sectionid="does-it-use-the-intel-compiler-icc">
<h3><aclass="toc-backref"href="#id11"role="doc-backlink">Does it use the Intel Compiler (icc)?</a><aclass="headerlink"href="#does-it-use-the-intel-compiler-icc"title="Link to this heading">¶</a></h3>
<p>No. Clear Linux OS uses open source compilers: <strongclass="command">gcc</strong> and <strongclass="command">clang</strong>. Clear Linux OS
does not compile any packages with <strongclass="command">icc</strong>.</p>
<p>For a more detailed explanation, see <aclass="reference external"href="https://community.clearlinux.org/t/does-clear-linux-os-use-the-intel-compiler-icc-tl-nope/">this discussion on the community forum</a>.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
</section>
<sectionid="software">
<h2><aclass="toc-backref"href="#id12"role="doc-backlink">Software</a><aclass="headerlink"href="#software"title="Link to this heading">¶</a></h2>
<h3><aclass="toc-backref"href="#id13"role="doc-backlink">How is software installed and updated?</a><aclass="headerlink"href="#how-is-software-installed-and-updated"title="Link to this heading">¶</a></h3>
<p>Clear Linux OS provides software in the form of <aclass="reference internal"href="../guides/clear/bundles.html#bundles-guide"><spanclass="std std-ref">bundles</span></a> and
updates software with <aclass="reference internal"href="../guides/clear/swupd.html#swupd-guide"><spanclass="std std-ref">swupd</span></a>.</p>
<p><aclass="reference internal"href="../tutorials/flatpak.html#flatpak-tutorial"><spanclass="std std-ref">Flatpak*</span></a> is an application virtualization solution
that allows more software to be available to Clear Linux OS users by augmenting the
software Clear Linux OS packages natively with software available through Flatpak.</p>
<p>Our goal is to have software packaged natively and made available through
<h3><aclass="toc-backref"href="#id14"role="doc-backlink">Does it use RPMs or DEBs packages like other distros?</a><aclass="headerlink"href="#does-it-use-rpms-or-debs-packages-like-other-distros"title="Link to this heading">¶</a></h3>
<p>No. Clear Linux OS provides software to systems in the form of <aclass="reference internal"href="../guides/clear/bundles.html#bundles-guide"><spanclass="std std-ref">Bundles</span></a>.
Under the hood, Clear Linux OS developers use the RPM format as an intermediary step for
packaging and determining software dependencies at OS build time.</p>
<p>Individual RPMs and DEBs can sometimes be manually extracted and installed on
a Clear Linux OS system with the right tools, but that is not the intended use case.</p>
<h3><aclass="toc-backref"href="#id15"role="doc-backlink">Why does it have a different approach to software management?</a><aclass="headerlink"href="#why-does-it-have-a-different-approach-to-software-management"title="Link to this heading">¶</a></h3>
<p>The Clear Linux OS team wants software <em>installation</em> and <em>updates</em> to be as efficient
and error free as possible. Clear Linux OS packages software differently and uses a
novel updater to solve some of the classic problems with how the software
packages are on Linux.</p>
<p>For a more detailed explanation, see <aclass="reference external"href="https://community.clearlinux.org/t/why-does-clearlinux-use-swupd-and-not-apt-deb-rpm/">this discussion on our community forum</a>.</p>
<h3><aclass="toc-backref"href="#id16"role="doc-backlink">Can I install a software package from another OS on Clear Linux OS?</a><aclass="headerlink"href="#can-i-install-a-software-package-from-another-os-on-cl"title="Link to this heading">¶</a></h3>
<p>Software that is packaged in other formats for other Linux distributions is
not guaranteed to work on Clear Linux OS and may be impacted by Clear Linux OS updates.</p>
<p>If the software you’re seeking is open source, please submit a request to add
it to Clear Linux OS. Submit requests on GitHub* here:
<h2><aclass="toc-backref"href="#id17"role="doc-backlink">Software availability</a><aclass="headerlink"href="#software-availability"title="Link to this heading">¶</a></h2>
<sectionid="what-software-is-available-on-cl">
<h3><aclass="toc-backref"href="#id18"role="doc-backlink">What software is available on Clear Linux OS?</a><aclass="headerlink"href="#what-software-is-available-on-cl"title="Link to this heading">¶</a></h3>
<p>Available software can be found in the <aclass="reference external"href="https://clearlinux.org/software">Software Store</a>, through the GNOME*
Software application on the desktop, or by using <aclass="reference internal"href="../guides/clear/swupd.html#swupd-quick-ref"><spanclass="std std-ref">swupd search</span></a>.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
<sectionid="is-google-chrome-available">
<h3><aclass="toc-backref"href="#id19"role="doc-backlink">Is Google* Chrome* available?</a><aclass="headerlink"href="#is-google-chrome-available"title="Link to this heading">¶</a></h3>
<p>The Google Chrome web browser is not distributed as a bundle in Clear Linux OS due to
copyright and licensing complexities.</p>
<p>A <aclass="reference external"href="https://github.com/clearlinux/distribution/issues/422">discussion on manually installing and maintaining Google Chrome</a> can be found on
<h3><aclass="toc-backref"href="#id20"role="doc-backlink">Is Microsoft* Visual Studio Code* available?</a><aclass="headerlink"href="#is-microsoft-visual-studio-code-available"title="Link to this heading">¶</a></h3>
<p>Yes. Find the CLI command for installing <aclass="reference external"href="https://clearlinux.org/software?search_api_fulltext=vscode">VS Code</a> and other Flatpak apps in
the <aclass="reference external"href="https://clearlinux.org/software">software store</a>. Installing Flatpak apps is also covered in our
<p>The Clear Linux OS team is working on a natively packaged version of Visual Studio Code
for future release.</p>
<p>Join a community <aclass="reference external"href="https://community.clearlinux.org/t/need-native-support-for-vs-code-through-swupd/">forum discussion about manually installing and maintaining
Visual Studio Code</a>.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
<sectionid="is-ffmpeg-available">
<spanid="licensing-restrict"></span><h3><aclass="toc-backref"href="#id21"role="doc-backlink">Is FFmpeg available?</a><aclass="headerlink"href="#is-ffmpeg-available"title="Link to this heading">¶</a></h3>
<p><aclass="reference external"href="https://ffmpeg.org/">FFmpeg</a> is a multimedia software suite, which is commonly used for
various media encoding/decoding, streaming, and playback.</p>
<p>Clear Linux OS does not distribute FFmpeg due to well-known licensing and legal
complexities (See <aclass="reference external"href="https://www.ffmpeg.org/legal.html">https://www.ffmpeg.org/legal.html</a> and
<p>While Clear Linux OS cannot distribute FFmpeg, solutions for manually building and
installing FFmpeg have been shared by users <aclass="reference external"href="https://github.com/clearlinux/distribution/issues/429">on GitHub</a> and <aclass="reference external"href="https://community.clearlinux.org/t/how-to-h264-etc-support-for-firefox-including-ffmpeg-install">the community
forums</a>.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
<sectionid="is-zfs-available">
<h3><aclass="toc-backref"href="#id22"role="doc-backlink">Is ZFS* available?</a><aclass="headerlink"href="#is-zfs-available"title="Link to this heading">¶</a></h3>
<p>ZFS is not available with Clear Linux OS because of copyright and licensing
complexities. BTRFS is an alternative filesystem that is available in Clear Linux OS
natively.</p>
<p>A community contributed tutorial has been shared on how to <aclass="reference internal"href="../tutorials/zfs.html#zfs"><spanclass="std std-ref">manually
install ZFS</span></a>.</p>
<divclass="line-block">
<divclass="line"><br/></div>
</div>
</section>
<sectionid="can-you-add-a-driver-that-i-need">
<h3><aclass="toc-backref"href="#id23"role="doc-backlink">Can you add a driver that I need?</a><aclass="headerlink"href="#can-you-add-a-driver-that-i-need"title="Link to this heading">¶</a></h3>
<p>If a kernel module is available as part of the Linux kernel source tree but
not enabled in the Clear Linux OS kernels, in many cases the Clear Linux OS team will enable it
<p>The Clear Linux OS team does not typically add out-of-tree kernel modules as a matter of
practice because of the maintenance overhead. If the driver was unable to be
merged upstream, there is a good chance we may be unable to merge it for
similar reasons.</p>
<p>Kernel modules can be individually built and installed on Clear Linux OS. See the
<aclass="reference internal"href="../guides/kernel/kernel-modules.html#kernel-modules"><spanclass="std std-ref">kernel modules</span></a> page for more information.</p>
<li><aclass="reference internal"href="#what-is-the-default-firewall">What is the default firewall?</a></li>
<li><aclass="reference internal"href="#where-are-the-files-that-i-usually-see-under-etc-like-fstab">Where are the files that I usually see under /etc like fstab?</a></li>
<li><aclass="reference internal"href="#does-it-use-the-intel-compiler-icc">Does it use the Intel Compiler (icc)?</a></li>
<li><aclass="reference internal"href="#how-is-software-installed-and-updated">How is software installed and updated?</a></li>
<li><aclass="reference internal"href="#does-it-use-rpms-or-debs-packages-like-other-distros">Does it use RPMs or DEBs packages like other distros?</a></li>
<li><aclass="reference internal"href="#why-does-it-have-a-different-approach-to-software-management">Why does it have a different approach to software management?</a></li>
<li><aclass="reference internal"href="#can-i-install-a-software-package-from-another-os-on-cl">Can I install a software package from another OS on Clear Linux OS?</a></li>
Some files were not shown because too many files have changed in this diff
Show More
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Beth Dean
