mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-07-07 21:25:48 +00:00
Revisions made for logical flow and toc:
- 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>
This commit is contained in:
@@ -6,26 +6,21 @@ Developer Workstation
|
||||
Overview
|
||||
********
|
||||
|
||||
*Developer Workstation* helps you find the tools you need to
|
||||
set up your developer workstation.
|
||||
*Developer Workstation* helps you find the bundles you need to
|
||||
start your |CL| development project.
|
||||
|
||||
First, we recommend learning how to use :ref:`swupd <swupd-guide>`.
|
||||
|
||||
Next, check out :ref:`swupd search <swupd-search>`, which shows:
|
||||
|
||||
* How to use `swupd` to search for bundles
|
||||
* How to use `swupd` to add bundles
|
||||
|
||||
How to use this document
|
||||
========================
|
||||
|
||||
This guide helps you understand the minimum bundles required to get started.
|
||||
After installing them, you can add more bundles relevant to your use
|
||||
case. To run any process required for Clear Linux developement, you may want
|
||||
to add the large bundle :ref:`*os-clr-on-clr* <enable-user-space>`.
|
||||
However, given how many packages this bundle contains, you may prefer
|
||||
instead to deploy a leaner OS with only bundles relevant to your project.
|
||||
Developer Workstation responds to this need.
|
||||
After installing them, you can add more bundles relevant to your use case.
|
||||
To run any process required for Clear Linux developement, you may want to
|
||||
add the large bundle :ref:`*os-clr-on-clr* <enable-user-space>`. However,
|
||||
given how many packages this bundle contains, you may prefer instead to
|
||||
deploy a leaner OS with only bundles relevant to your project. Developer
|
||||
Workstation responds to this need.
|
||||
|
||||
Use Table 1, *Clear Linux Developer Profiles*, to identify the *minimum
|
||||
required bundles* to get started developing based on your role or project.
|
||||
@@ -80,6 +75,15 @@ as a starting point.
|
||||
-
|
||||
- ✓
|
||||
|
||||
|
||||
Second, try out :ref:`swupd search <swupd-search>`, to learn the commands to
|
||||
search for and add bundles relevant to your project.
|
||||
|
||||
:ref:`swupd-search` shows you how to:
|
||||
|
||||
* Use `swupd` to search for bundles
|
||||
* Use `swupd` to add bundles
|
||||
|
||||
Core Concepts
|
||||
=============
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ maintaining |CLOSIA| after :ref:`installation <get-started>` is completed.
|
||||
:maxdepth: 2
|
||||
|
||||
developer-workstation
|
||||
swupd-search
|
||||
enable-user-space
|
||||
swupd-guide
|
||||
bulk-provision
|
||||
|
||||
@@ -1,40 +1,45 @@
|
||||
.. _swupd-search:
|
||||
|
||||
Use swupd search to find a bundle
|
||||
Use swupd search to find bundles
|
||||
#################################
|
||||
|
||||
.. contents:: :local:
|
||||
depth: 2
|
||||
|
||||
This help document shows you how to use `swupd search` as a Developer.
|
||||
This help document shows you how to use `swupd search` to search for and add
|
||||
a bundle.
|
||||
|
||||
Assumptions:
|
||||
Assumptions
|
||||
***********
|
||||
|
||||
* Basic knowledge of using :ref:`swupd <swupd-guide>`
|
||||
* Understanding how :ref:`swupd <swupd-about>` differs from
|
||||
You have:
|
||||
|
||||
* A basic knowledge of using :ref:`swupd <swupd-guide>`
|
||||
* An Understanding how :ref:`swupd <swupd-about>` differs from
|
||||
other Linux\* distributions
|
||||
* You plan to use :ref:`mixer` to build your own |CLOSIA|for a specific
|
||||
* A plan to use :ref:`mixer` to build your own |CLOSIA|for a specific
|
||||
use case
|
||||
|
||||
This example illustrates how to search for and add a bundle.
|
||||
How do I search for a bundle?
|
||||
*****************************
|
||||
|
||||
Scenario 1: Data Science with Python
|
||||
====================================
|
||||
Example: Python Data Science
|
||||
============================
|
||||
|
||||
We're developing a custom Clear Linux OS for data science with Python. We'll
|
||||
develop our own mix, from which we'll create a release image. That image
|
||||
will be distributed to data center (DC) clients across the United States
|
||||
who need this data to determine DC workload balancing. Why? We need to
|
||||
create a tool to analyze energy consumption based on population
|
||||
statistics and consumption data. Our tool's custom dashboard will include
|
||||
heat-maps showing where and when energy consumption peaks in large
|
||||
who need to determine DC workload balancing during peak energy hours.
|
||||
We will create a tool to analyze energy consumption based on population
|
||||
statistics and consumption data. Our tool's dashboard will show heat-maps
|
||||
of where and charts of when energy consumption peaks in large
|
||||
metropolitan areas.
|
||||
|
||||
So far, we know we need Python data science capabilities.
|
||||
So far, we know we need a Python *data science* bundle.
|
||||
|
||||
First, use :command:`swupd search` with a general term like *Python*.
|
||||
|
||||
#. Enter this command and add 'Python' as the search term:
|
||||
#. Enter this command, followed by 'Python' as the search term:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@@ -46,9 +51,9 @@ First, use :command:`swupd search` with a general term like *Python*.
|
||||
Enter only one term, or one hyphenated term, at a time.
|
||||
Use the command :command:`man swupd` to learn more.
|
||||
|
||||
`-b` flag, or `--binary`, means: Restrict search to program binary paths.
|
||||
`-b` flag, or `--binary`, means: Restrict search to program binary paths.
|
||||
|
||||
#. Results of `swupd search` shows the best match for our use case.
|
||||
#. Viewing `swupd search` result, we choose the best match for our use case.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@@ -58,16 +63,20 @@ First, use :command:`swupd search` with a general term like *Python*.
|
||||
|
||||
.. note::
|
||||
|
||||
Result above is one of several shown in standard output.
|
||||
The results *Python* is one of several shown.
|
||||
|
||||
If the bundle is already installed, *[installed]* appears in search results. If that doesn't apppear, the bundle needs to be installed.
|
||||
|
||||
#. Add the bundle `python-data-science`.
|
||||
#. Add the bundle `python-data-science`:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd bundle-add python-data-science
|
||||
|
||||
.. note::
|
||||
|
||||
To add other bundles, replace `python-data-science` with your selected bundle.
|
||||
|
||||
#. When prompted, enter your password.
|
||||
|
||||
.. note::
|
||||
@@ -97,7 +106,9 @@ Find answers to these common questions:
|
||||
|
||||
* How do I show all :ref:`bundles available<swupd-guide>`?
|
||||
|
||||
* How do I :ref:`add new bundles<swupd-guide>`?
|
||||
* How do I :ref:`update swupd<swupd-guide>`?
|
||||
|
||||
* How do I :ref:`remove bundles<swupd-guide>`?
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
Reference in New Issue
Block a user