Add improved role descriptions and bundles to developer-workstation (#947)

* Add bundle function and desc to developer-workstation.
- Closes #764

* Add more bundles relevant to each role.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Add `ltp` to kernel developer; revise AI Dev to AI/ML Engineer.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Revise bundles listed for kernel developer and add maker dev.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Removes Embedded Systems profile due to few relevant bundles.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Remove game developer per review from @ahkok.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Adds containers-virt to Computer Vis. Engineer; and reference note.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
This commit is contained in:
michael vincerra
2019-12-12 10:42:43 -08:00
committed by GitHub
parent e2e1a2896c
commit cdaa36e279
@@ -17,67 +17,183 @@ other Linux\* distributions.
Workstation Setup
*****************
After installing the minimum set of bundles required to get started, you can add
more bundles relevant to your specific use case.
After installing the minimum set of bundles required to get started, you can
add more bundles relevant to your specific use case.
To run any process required for |CL| development, you can add the large bundle
:ref:`*os-clr-on-clr* <enable-user-space>`. However, given how many packages this
bundle contains, you may want to deploy a leaner OS with only bundles relevant to
your project.
To run any process required for |CL| development, you can add the large
bundle :ref:`*os-clr-on-clr* <enable-user-space>`. However, you may want to deploy a leaner OS with only bundles relevant to your project.
Use Table 1, *Developer Profiles*, to identify the *minimum
required bundles* to get started developing based on your role or project.
While your role may not neatly fit in one of these categories, consider
Table 1 as a starting point.
Use the **Developer Profiles** tabs to start installing *suggested bundles*
based on your role or project. Installing any ``dkms`` bundle gives all the
tools you need to start. Consider these profiles as a starting point.
.. list-table:: **Table 1. Developer Profiles**
:widths: 20, 20, 20, 20
:header-rows: 1
.. tip::
Click on a bundle to learn how to install it using :command:`swupd`.
* - |CL| Bundle
- *Internet of Things (IoT)*
- *System Administrator*
- *Client/Cloud/Web Developer*
.. tabs::
* - :command:`editors`
- ✓
- ✓
- ✓
.. tab:: AI/ML Engineer
* - :command:`network-basic`
- ✓
- ✓
- ✓
.. list-table::
:widths: 50, 50
:header-rows: 1
* - :command:`openssh-server`
- ✓
- ✓
- ✓
* - Function
- Bundle
* - :command:`webserver-basic`
-
- ✓
- ✓
* - Build machine learning applications with a full suite of libraries.
- `machine-learning-basic <https://clearlinux.org/software/bundle/machine-learning-basic/>`_
* - :command:`application-server`
-
- ✓
- ✓
* - Build machine learning applications with PyTorch, an optimized tensor library for deep learning.
- `machine-learning-pytorch <https://clearlinux.org/software/bundle/machine-learning-pytorch/>`_
* - :command:`database-basic`
-
- ✓
- ✓
* - Build machine learning applications using Tensorflow, a library for numerical computation using deep neural networks.
- `machine-learning-tensorflow <https://clearlinux.org/software/bundle/machine-learning-tensorflow/>`_
* - :command:`desktop-autostart`
- ✓
- ✓
- ✓
* - Web-based, interactive tools for machine learning.
- `machine-learning-web-ui <https://clearlinux.org/software/bundle/machine-learning-web-ui/>`_
* - :command:`dev-utils`
-
-
- ✓
* - Machine learning Docker container.
- `machine-learning <https://clearlinux.org/software/docker/machine-learning/>`_
* - Pre-built Python libraries for Data Science.
- `python-extras <https://clearlinux.org/software/bundle/python-extras>`_
* - API helper for cloud access.
- `cloud-api <https://clearlinux.org/software/bundle/cloud-api/>`_
.. tab:: Computer Vision Engineer
.. list-table::
:widths: 50, 50
:header-rows: 1
* - Function
- Bundle
* - Build computer vision applications.
- `computer-vision-basic <https://clearlinux.org/software/bundle/computer-vision-basic/>`_
* - Work with deep learning and edge-optimized models.
- `computer-vision-models <https://clearlinux.org/software/bundle/computer-vision-models/>`_
* - Basic OpenVINO™ toolkit.
- `computer-vision-openvino <https://clearlinux.org/software/bundle/computer-vision-openvino/>`_
* - API helper for cloud access.
- `cloud-api <https://clearlinux.org/software/bundle/cloud-api/>`_
* - Run container applications from Dockerhub in lightweight virtual machines.
- `containers-virt <https://clearlinux.org/software/bundle/containers-virt>`_
* - All content for pkgconfig file opencv.pc.
- `devpkg-opencv <https://clearlinux.org/software/bundle/devpkg-opencv/>`_
* - *Refer also to Cloud Orchestration Engineer*
-
.. tab:: Cloud Orchestration Engineer
.. list-table::
:widths: 50, 50
:header-rows: 1
* - Function
- Bundle
* - Contains Clear Linux\* OS native software for cloud.
- `ethtool <https://clearlinux.org/software/bundle/ethtool/>`_
* - Utilities for controlling TCP/IP networking and traffic control.
- `iproute2 <https://clearlinux.org/software/bundle/iproute2/>`_
* - API helper for cloud access.
- `cloud-api <https://clearlinux.org/software/bundle/cloud-api/>`_
* - C++ runtime support.
- `libstdcpp <https://clearlinux.org/software/bundle/libstdcpp/>`_
* - Load and enumerate PKCS#11 modules.
- `p11-kit <https://clearlinux.org/software/bundle/p11-kit/>`_
.. tab:: Kernel Developer
.. list-table::
:widths: 50, 50
:header-rows: 1
* - Function
- Bundle
* - Installs kernel, initrd, kernel config, system map; creates a bootloader entry.
- `kernel-install <https://clearlinux.org/software/bundle/kernel-install/>`_
* - Support module for building/loading via Dynamic Kernel Module System (DKMS) in LTS kernel.
- `kernel-lts-dkms <https://clearlinux.org/software/bundle/kernel-lts-dkms/>`_
* - Support module for building/loading via Dynamic Kernel Module System (DKMS) in native kernel.
- `kernel-native-dkms <https://clearlinux.org/software/bundle/kernel-native-dkms/>`_
* - Support module for building/loading via Dynamic Kernel Module System (DKMS) in AWS kernel.
- `kernel-aws-dkms <https://clearlinux.org/software/bundle/kernel-aws-dkms/>`_
* - Run the Kernel-based Virtual Machine (KVM) with |CL| as a guest under KVM.
- `kernel-kvm <https://clearlinux.org/software/bundle/kernel-kvm/>`_
* - Linux Test Project.
- `ltp <https://clearlinux.org/software/bundle/ltp/>`_
.. tab:: Maker Developer
.. list-table::
:widths: 50, 50
:header-rows: 1
* - Function
- Bundle
* - Basic tools for makers and experimenters.
- `maker-basic <https://clearlinux.org/software/bundle/maker-basic/>`_
* - GIS/Mapping tools for makers.
- `maker-gis <https://clearlinux.org/software/bundle/maker-gis/>`_
* - Electronic Design Tool.
- `Fritzing <https://clearlinux.org/software/flathub/fritzing>`_
* - Open-source electronics prototyping platform.
- `arduino-ide <https://clearlinux.org/software/flathub/arduino-ide/>`_
.. tab:: System Administrator
.. list-table::
:widths: 50, 50
:header-rows: 1
* - Function
- Bundle
* - Run popular terminal text editors.
- `editors <https://clearlinux.org/software/bundle/editors/>`_
* - Run network utilities and modify network settings.
- `network-basic <https://clearlinux.org/software/bundle/network-basic/>`_
* - Run a secure shell (SSH) server for access from remote machines.
- `openssh-server <https://clearlinux.org/software/bundle/openssh-server/>`_
* - Run a HTTP web server.
- `web-server-basic <https://clearlinux.org/software/bundle/web-server-basic>`_
* - Run an application server via HTTP.
- `application-server <https://clearlinux.org/software/bundle/application-server/>`_
* - Run an SQL database.
- `database-basic <https://clearlinux.org/software/bundle/database-basic>`_
* - Bundle to automatically launch the GUI upon boot.
- `desktop-autostart <https://clearlinux.org/software/bundle/desktop-autostart/>`_
swupd search
************
@@ -101,8 +217,8 @@ developing your project.
* :ref:`Mixer <mixer>`
* :ref:`Autospec <autospec>`
Other resources for developers
-----------------------------------
Related topics
--------------
* `Developer Tooling Framework`_ for |CL|
* `Bundle Definition Files`_