17 | if (contents[i].tagName.toLowerCase() == 'div') {
18 | var element = contents[i].children[0];
19 | var element_type = element.tagName.toLowerCase();
20 | var btn_id;
21 | var divElement;
22 |
23 | divElement = contents[i];
24 | btn_id = contents[i].id;
25 |
26 | //if the next element is a span skip to the header
27 | if (element_type == 'span') {
28 | element = contents[i].children[1];
29 | element_type = element.tagName.toLowerCase();
30 | } else {
31 | divElement.id = "";
32 | }
33 |
34 | var btn = document.createElement("BUTTON");
35 | //If it is a header capture which level and pass on to button
36 | if (element_type.length == 2 && element_type[0] == 'h') {
37 | var newClass = 'clps' + element_type[1];
38 | //collapses the section by default only if javascript is working
39 | contents[i].style.maxHeight = 0;
40 | //Build the button and define behavior
41 | btn.className += " " + newClass;
42 | btn.innerHTML = element.innerHTML;
43 | btn.className += " collapsible";
44 | btn.id = btn_id;
45 | btn.addEventListener("click", function() {
46 | this.classList.toggle("active");
47 | var content = this.nextElementSibling;
48 | if (content.style.maxHeight != "0px"){
49 | content.style.maxHeight = 0;
50 | } else {
51 | content.style.maxHeight = content.scrollHeight + "px";
52 | }
53 | });
54 |
55 | //Add the button to the page and remove the header
56 | contents[i].parentNode.insertBefore(btn, contents[i]);
57 | contents[i].removeChild(element);
58 | }
59 | }
60 | }
--------------------------------------------------------------------------------
/source/get-started/compatibility-check.rst:
--------------------------------------------------------------------------------
1 | .. _compatibility-check:
2 |
3 | Check processor and EFI firmware compatibility
4 | ##############################################
5 |
6 | Before installing |CL-ATTR|, check your host system's processor and EFI firmware
7 | compatibility. To check compatibilty, choose one of the following paths:
8 |
9 | * From a system with a Linux\* OS installed, follow the instructions to :ref:`check-compatibility-steps`.
10 |
11 | * From a non-Linux OS, first :ref:`bare-metal-install-desktop` and then follow
12 | the instructions to :ref:`check-compatibility-steps`.
13 |
14 | .. note::
15 | This does not check other system components (for example: storage and
16 | graphics) for compatibility with |CL|.
17 |
18 | .. _check-compatibility-steps:
19 |
20 | Check compatibility
21 | *******************
22 |
23 | #. Download the `clear-linux-check-config.sh`_ file.
24 |
25 | If a browser is not available, use:
26 |
27 | .. code-block:: console
28 |
29 | curl -O https://cdn.download.clearlinux.org/current/clear-linux-check-config.sh
30 |
31 | #. Make the script executable.
32 |
33 | .. code-block:: console
34 |
35 | chmod +x clear-linux-check-config.sh
36 |
37 | #. Run the script.
38 |
39 | #. Check to see if the host's processor and EFI firmware is capable of
40 | running |CL|.
41 |
42 | .. code-block:: console
43 |
44 | ./clear-linux-check-config.sh host
45 |
46 | #. Check to see if the host is capable of running |CL| in a container.
47 |
48 | .. code-block:: console
49 |
50 | ./clear-linux-check-config.sh container
51 |
52 | The script prints a list of test results similar to the output below.
53 | All items should return a `SUCCESS` status. This example indicates the
54 | host's processor and EFI firmware support running |CL|.
55 |
56 | .. code-block:: console
57 |
58 | Checking if host is capable of running Clear Linux* OS
59 |
60 | SUCCESS: 64-bit CPU (lm)
61 | SUCCESS: Supplemental Streaming SIMD Extensions 3 (ssse3)
62 | SUCCESS: Streaming SIMD Extension v4.1 (sse4_1)
63 | SUCCESS: Streaming SIMD Extensions v4.2 (sse4_2)
64 | SUCCESS: Advanced Encryption Standard instruction set (aes)
65 | SUCCESS: Carry-less Multiplication extensions (pclmulqdq)
66 | SUCCESS: EFI Firmware
67 |
68 | .. _clear-linux-check-config.sh: https://cdn.download.clearlinux.org/current/clear-linux-check-config.sh
69 |
--------------------------------------------------------------------------------
/source/tutorials/smb-desktop.rst:
--------------------------------------------------------------------------------
1 | .. _smb-desktop:
2 |
3 | Samba\* as a client
4 | ###################
5 |
6 | This tutorial explains how to access an existing shared drive on
7 | Windows\* via Server Message Block (SMB) / Common Internet File System (CIFS)
8 | from the |CL| GNOME desktop. CIFS filesystem is generally used to access
9 | shared storage locations, or share files.
10 |
11 | Prerequisites
12 | *************
13 |
14 | * You have already `set up a shared location on Windows`_
15 |
16 | Connect to Windows shared location with Nautilus
17 | ************************************************
18 |
19 | #. From the desktop, select :guilabel:`Files` from the application menu.
20 |
21 | .. note::
22 |
23 | GNOME Files is also known as `Nautilus`.
24 |
25 | #. In :guilabel:`Files`, select :guilabel:`Other Locations`.
26 |
27 | .. figure:: /_figures/samba/smb-desktop-1.png
28 | :scale: 100%
29 | :alt: Files, Other Locations
30 |
31 | Figure 1: Files, Other Locations
32 |
33 | #. In the lower taskbar, beside :guilabel:`Connect to Server`,
34 | enter the file-sharing address using the Windows sharing schema:
35 |
36 | .. code-block:: bash
37 |
38 | smb://servername/Share
39 |
40 | .. figure:: /_figures/samba/smb-desktop-2.png
41 | :scale: 100%
42 | :alt: Connect to Server
43 |
44 | Figure 2: Connect to Server
45 |
46 | #. Optional: If there are issues with DNS, you can use an IP address in
47 | place of the `servername` above. You must still specify the share.
48 |
49 | #. Optional: On the Windows machine, in a CLI, retrieve the IP address by
50 | entering the command:
51 |
52 | .. code-block:: bash
53 |
54 | ifconfig
55 |
56 | .. note::
57 |
58 | If using the IP address, assure that it is accessible and secure.
59 |
60 | #. Select :guilabel:`Connect`.
61 |
62 | #. The server will request authentication, as shown in Figure 3.
63 |
64 | .. figure:: /_figures/samba/smb-desktop-3.png
65 | :scale: 100%
66 | :alt: Authentication
67 |
68 | Figure 3: Authentication
69 |
70 | #. Log in with the same Windows system credentials for which you granted
71 | access to the share.
72 |
73 | #. Select the appropriate checkbox to save your credentials. Consider
74 | carefully the security risks as a result of your selection.
75 |
76 |
77 | .. _set up a shared location on Windows: https://www.howtogeek.com/176471/how-to-share-files-between-windows-and-linux/
78 |
79 |
80 |
81 |
--------------------------------------------------------------------------------
/source/guides/maintenance/fix-broken-install.rst:
--------------------------------------------------------------------------------
1 | .. _fix-broken-install:
2 |
3 | Fix a broken installation
4 | #########################
5 |
6 | This guide explains how to fix a broken installation of |CL-ATTR| using a live
7 | desktop image on a USB.
8 |
9 | .. contents::
10 | :local:
11 | :depth: 1
12 |
13 | Overview
14 | ********
15 |
16 | This guide assumes you have installed |CL| on a target system, but the OS
17 | does not boot or function properly.
18 |
19 | The process described in this guide can only verify and fix files that
20 | :ref:`swupd
` owns in :file:`/usr`. Files outside of this path, such
21 | as :file:`/home/`, :file:`/etc`, :file:`/var`, etc., cannot be repaired by this
22 | process.
23 |
24 | Prerequisites
25 | *************
26 |
27 | * Download and install the live desktop image on a USB. See
28 | :ref:`bare-metal-install-desktop` for install instructions.
29 |
30 | Boot a live desktop image to fix target system
31 | **********************************************
32 |
33 | #. Boot the |CL| live desktop image.
34 |
35 | .. include:: ../../get-started/bare-metal-install-desktop.rst
36 | :start-after: install-on-target-start:
37 | :end-before: install-on-target-end:
38 |
39 | Mount root partition, verify, and fix
40 | *************************************
41 |
42 | #. Open a Terminal window.
43 |
44 | #. Ensure the system is connected to the network.
45 |
46 | #. Mount the system’s root partition.
47 |
48 | #. To find the root partition, run:
49 |
50 | .. code-block:: bash
51 |
52 | lsblk
53 |
54 | We'll use :file:`/dev/sda3/` as the root partition example.
55 |
56 | #. Next, mount the partition to the :file:`/mnt` folder.
57 |
58 | .. code-block:: bash
59 |
60 | sudo mount /dev/sda3 /mnt
61 |
62 | #. Verify that you mounted the correct root partition by checking for some
63 | files commonly found on |CL| systems.
64 |
65 | .. code-block:: bash
66 |
67 | cat /mnt/usr/lib/os-release
68 | ls /mnt/usr/share/clear/bundles
69 |
70 | #. Next, run swupd to fix any issues on the target system.
71 |
72 | .. code-block:: bash
73 |
74 | sudo swupd repair --picky --path=/mnt
75 |
76 | :ref:`Learn more about how swupd works `.
77 |
78 | #. After the process is complete, unmount the root partition:
79 |
80 | .. code-block:: bash
81 |
82 | sudo umount /mnt
83 |
84 | #. Reboot the system, remove the live desktop USB drive,
85 | and boot into the repaired system.
86 |
87 | .. code-block:: bash
88 |
89 | sudo reboot
90 |
91 | **Congratulations!** You successfully restored |CL|.
92 |
--------------------------------------------------------------------------------
/source/_scripts/_python/bundle_lister.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import io
4 | import os
5 | import re
6 | import urllib
7 | import jinja2
8 | from jinja2 import Environment, FileSystemLoader, Template
9 | import git
10 | from operator import itemgetter
11 | from datetime import datetime
12 |
13 | GITHUB_BASE = "https://github.com/clearlinux/clr-bundles/tree/master/bundles/"
14 |
15 | PATTERN1 = re.compile(r"#\s?\[TITLE]:\w?(.*)")
16 | PATTERN2 = re.compile(r"#\s?\[DESCRIPTION]:\w?(.*)")
17 | PATTERN3 = re.compile(r"(?<=include)\(.*\)", re.MULTILINE)
18 | PATTERN4 = re.compile(r"(#\s?\[STATUS]):\s?(.*)")
19 |
20 | def extractor(lines):
21 | bundle_title = "title"
22 | data_desc = "description"
23 | url = "url"
24 | include_list = []
25 | include_unique = []
26 | status = "status"
27 |
28 | for i in lines:
29 | title = PATTERN1.match(i)
30 | desc = PATTERN2.match(i)
31 | includes = PATTERN3.findall(i)
32 | curr_status = PATTERN4.match(i)
33 | if title:
34 | bundle_title = title.groups(0)[0].strip()
35 | if desc:
36 | data_desc = desc.groups(0)[0].strip()
37 | if url:
38 | url = os.path.join(GITHUB_BASE, bundle_title)
39 | if curr_status:
40 | status = curr_status.group(2)
41 | if includes:
42 | include_text = includes[0].strip("()")
43 | include_list.append(include_text)
44 | include_unique = set(include_list)
45 | return {"title": bundle_title, "data_desc": data_desc, "include_list": include_unique, "url": url, "status": status}
46 |
47 | def main():
48 | data = []
49 | try:
50 | git.Git("./cloned_repo/").clone("https://github.com/clearlinux/clr-bundles.git")
51 | except:
52 | pass
53 | for root, dirs, files in os.walk("./cloned_repo/clr-bundles/bundles", topdown=False):
54 | for name in files:
55 | with open(os.path.join(root, name)) as file_obj:
56 | lines = file_obj.readlines()
57 | data.append(extractor(lines))
58 |
59 | filtered = list(filter(lambda x: x.get('title'), data))
60 | sortedData = sorted(filtered, key=lambda x:x['title'].lower())
61 | loader = jinja2.FileSystemLoader(searchpath='./')
62 | env = jinja2.Environment(loader=loader)
63 | template = env.get_template('template.html')
64 | template.globals['now'] = datetime.utcnow
65 | output = template.render(data=sortedData, now=datetime.utcnow())
66 | with io.open('bundles.html.txt', 'w') as file:
67 | file.write(output)
68 |
69 | if __name__ == "__main__":
70 | main()
71 |
--------------------------------------------------------------------------------
/locale/zh_CN/LC_MESSAGES/get-started/index.po:
--------------------------------------------------------------------------------
1 | # SOME DESCRIPTIVE TITLE.
2 | # Copyright (C) 2019, many
3 | # This file is distributed under the same license as the Clear Linux*
4 | # Project Docs package.
5 | # FIRST AUTHOR , 2019.
6 | #
7 | msgid ""
8 | msgstr "Project-Id-Version: Clear Linux* Project Docs latest\n"
9 | "Report-Msgid-Bugs-To: \n"
10 | "POT-Creation-Date: 2019-08-09 14:33-0700\n"
11 | "PO-Revision-Date: 2019-09-04 16:21-0008\n"
12 | "Last-Translator: FULL NAME \n"
13 | "Language: zh-Hans\n"
14 | "Language-Team: zh-Hans\n"
15 | "Plural-Forms: nplurals=2; plural=(n != 1)\n"
16 | "MIME-Version: 1.0\n"
17 | "Content-Type: text/plain; charset=utf-8\n"
18 | "Content-Transfer-Encoding: 8bit\n"
19 | "Generated-By: Intel® International Developer Studio Version 4.1.273.0\n"
20 |
21 | #: ../../get-started/index.rst:4
22 | msgid "Get started"
23 | msgstr "开始使用"
24 |
25 | #: ../../get-started/index.rst:6
26 | msgid ""
27 | "The Get Started section guides you through the requirements and "
28 | "installation of |CL-ATTR|. Follow these step-by-step intructions to get "
29 | "started with |CL|, fast."
30 | msgstr "“开始使用”一节引导用户了解 |CL-ATTR| 的要求并完成安装。逐步按照说明操作，快速开始使用 |CL|。"
31 |
32 | #: ../../get-started/index.rst:10
33 | msgid "Pre-install"
34 | msgstr "安装前"
35 |
36 | #: ../../get-started/index.rst:12
37 | msgid "There are a couple of things to take care of before you install."
38 | msgstr "安装前有一些需要注意的事项。"
39 |
40 | #: ../../get-started/index.rst:14
41 | msgid ":ref:`system-requirements`"
42 | msgstr ":ref:`system-requirements`"
43 |
44 | #: ../../get-started/index.rst:15
45 | msgid ":ref:`compatibility-check`"
46 | msgstr ":ref:`compatibility-check`"
47 |
48 | #: ../../get-started/index.rst:16
49 | msgid ":ref:`bootable-usb`"
50 | msgstr ":ref:`bootable-usb`"
51 |
52 | #: ../../get-started/index.rst:18
53 | msgid "When installing |CL-ATTR| in a VM, consider which kernel to use."
54 | msgstr "在虚拟机上安装 |CL-ATTR| 时，考虑使用哪种内核。"
55 |
56 | #: ../../get-started/index.rst:20
57 | msgid ":ref:`Compatible VM kernels `"
58 | msgstr ":ref:`Compatible VM kernels `"
59 |
60 | #: ../../get-started/index.rst:30
61 | msgid "Install"
62 | msgstr "安装"
63 |
64 | #: ../../get-started/index.rst:42
65 | msgid "Install in a virtual machine"
66 | msgstr "在虚拟机上安装"
67 |
68 | #: ../../get-started/index.rst:52
69 | msgid "Deploy to the cloud"
70 | msgstr "部署到云"
71 |
72 | #~ msgid ""
73 | #~ "The Get Started section will get "
74 | #~ "you up and running fast with "
75 | #~ "|CL-ATTR|. Use these step-by-step "
76 | #~ "instructions to guide you through the"
77 | #~ " installing |CL| from a live desktop"
78 | #~ " or to a virtual machine."
79 | #~ msgstr ""
80 |
81 |
82 |
--------------------------------------------------------------------------------
/source/reference/compatible-hardware.rst:
--------------------------------------------------------------------------------
1 | .. _compatible-hardware:
2 |
3 | Compatible Hardware
4 | ###################
5 |
6 | This document describes hardware that has been tested and confirmed as
7 | compatible with |CL-ATTR|. This list is not comprehensive and will continue to
8 | grow.
9 |
10 | .. list-table:: **Table 1. Compatible Hardware**
11 | :widths: 20, 20
12 | :header-rows: 1
13 |
14 | * - Processor SKU
15 | - Platform
16 |
17 | * - Intel® Core™ i5-6260U
18 | -
19 |
20 | * - Intel® Core™ i5-6560U
21 | - Dell XPS\* 13 9350
22 |
23 | * - Intel® Celeron® J3455
24 | - NUC6CAYS
25 |
26 | * - Intel® Core™ i5-4250U
27 | -
28 |
29 | * - Intel® Core™ i7-5557U
30 | -
31 |
32 | * - Intel® Core™ i9-7900X
33 | - Gigabyte\* X299
34 |
35 | * - Intel® Core™ i3-4130
36 | - Lenovo Thinkserver\* TS140
37 |
38 | * - Intel® Core™ i7-7567U
39 | - NUC7i7BNH
40 |
41 | * - Intel® Core™ i7-8809G
42 | - NUC8i7HVK
43 |
44 | * - Intel® Core™ i5-7260U
45 | - NUC7i5BNH
46 |
47 | * - Intel® Core™ i7-8650U
48 | - NUC7i7DNKE
49 |
50 | * - Intel® Core™ i5-7300U
51 | - NUC7i5DNHE
52 |
53 | * - Intel® Xeon® Gold 6138
54 | -
55 |
56 | * - Intel® Xeon® E5-2699A v4
57 | - Dell PowerEdge\* R630
58 |
59 | * - Intel® Xeon® E5-2620 v3
60 | -
61 |
62 | * - Intel® Core™ i5-6600
63 | - Gigabyte\* Z170X-UD5
64 |
65 | * - Intel® Core™ i5-4250U
66 | - D54250WYK
67 |
68 | * - Intel® Xeon® E5-2699 v3
69 | - S2600WT2
70 |
71 | * - Intel® Atom™ J3455
72 | - NUC6CAYB
73 |
74 | * - Intel® Xeon® Bronze 3104
75 | - 0W23H8
76 |
77 | * - Intel® Atom™ C2750
78 | - SuperMicro\* A1SAi
79 |
80 | * - Intel® Atom™ E3825
81 | - CircuitCo MinnowBoard MAX\*
82 |
83 | * - Intel® Core™ i7-8700
84 | - Gigabyte\* H370 WIFI
85 |
86 | * - Intel® Core™ i7-3667U
87 | - Lenovo ThinkPad\* X1 Carbon laptop
88 |
89 | * - Intel® Core™ i5-4210U
90 | - Dell XPS\* 13 laptop
91 |
92 | * - Intel® Celeron® J3455
93 | - NUC6CAYB
94 |
95 | * - Intel® Core™ i7-4790
96 | - Gigabyte\* desktop
97 |
98 | * - Intel® Core™ i5-6260U
99 | - NUC6I6SYH
100 |
101 | * - Intel® Core™ i7-5557U
102 | - NUC5I7RYH
103 |
104 | * - Intel® Core™ i7-4700MQ
105 | - Lenovo ThinkPad\* T540p
106 |
107 | * - Intel® Core™ i7-5557U
108 | - NUC5I7RYB
109 |
110 | * - Intel® Core™ i5-6260U
111 | - NUC6I5SYH
112 |
113 | \* Other names and brands may be claimed as the property of others.
--------------------------------------------------------------------------------
/source/about.rst:
--------------------------------------------------------------------------------
1 | .. _about:
2 |
3 | About
4 | #####
5 |
6 | The |CL| delivers a secure, hardware optimized OS. Its easy updates ensure that
7 | software dependencies remain mutually compatible.
8 |
9 | |CL| does this via custom infrastructure components and process innovations.
10 |
11 | .. contents::
12 | :local:
13 | :depth: 1
14 |
15 |
16 | For detailed information on these topics, refer to the :ref:`cl-guides` guides.
17 |
18 |
19 | Release Cadence
20 | ***************
21 |
22 | |CL| updates are based on a rolling release that can occur daily, up to a few
23 | times per week. Each release has a unique version number that
24 | identifies every component in the OS from kernel, to driver, to tool, to GUI
25 | application. Most components are included in entities called *bundles*.
26 |
27 | Updates
28 | *******
29 |
30 | By default, |CL| automatically checks for updates, ensuring that the latest
31 | performance and security fixes are installed as soon as they are available.
32 | :ref:`swupd-guide` is the custom tool designed to manage updates and bundles.
33 |
34 | |CL| is :ref:`stateless` to make sure that system components can be updated
35 | without impacting user settings.
36 |
37 |
38 | Ease of Use
39 | ***********
40 |
41 | |CL| makes it easier to manage a number of difficult problems.
42 |
43 | * :ref:`autoproxy` makes it possible for |CL| tools to operate in some proxy
44 | environments without needing to be configured.
45 |
46 | * Being :ref:`stateless` means that configuration settings are easier to manage
47 | and remain untouched when system sofware is updated.
48 |
49 | * :ref:`swupd-guide` simplifies managing software and maintaining compatibility.
50 |
51 | Custom Derivatives
52 | ******************
53 |
54 | The same tools used to build the |CL| are available *in* the OS. These tools can
55 | be used to create a custom distribution that continues to benefit from upstream
56 | rolling releases.
57 |
58 | .. figure:: /_figures/about/clear-lifecycle.png
59 | :scale: 75%
60 | :align: center
61 | :alt: Creating and managing a Clear Linux* OS version (or derivative)
62 |
63 | Figure 1: Creating and managing a Clear Linux\* OS version (or derivative)
64 |
65 | Create
66 | ======
67 |
68 | To create a custom distribution you need to understand how to use the
69 | :ref:`autospec` and :ref:`mixer` tools.
70 |
71 | Additional training materials are available in the `how-to-clear`_ GitHub\*
72 | project to help you get started with |CL| tools.
73 |
74 | Deploy
75 | ======
76 |
77 | We also provide training on how to :ref:`deploy-at-scale`.
78 |
79 | Administrate
80 | ============
81 |
82 | |CL| provides a :ref:`telem-guide` solution for collecting useful information
83 | about a deployment, as well as :ref:`debug` capabilities.
84 |
85 | .. _how-to-clear: https://github.com/clearlinux/how-to-clear
86 |
--------------------------------------------------------------------------------
/source/get-started/virtual-machine-install/hyper-v.rst:
--------------------------------------------------------------------------------
1 | .. _hyper-v:
2 |
3 | |CL-ATTR| on Microsoft Hyper-V\*
4 | ################################
5 |
6 | This page explains how to run |CL-ATTR| inside a
7 | `Windows Server Virtualization`_\* or **Hyper-V** environment.
8 |
9 | .. contents::
10 | :local:
11 | :depth: 1
12 |
13 | Prerequisites
14 | *************
15 |
16 | * Enable `Intel® Virtualization Technology`_ (Intel® VT)
17 |
18 | * Enable `Intel® Virtualization Technology for Directed I/O`_ (Intel® VT-d) in
19 | your BIOS/UEFI firmware configuration.
20 |
21 | Enable Hyper-V
22 | **************
23 |
24 | Please refer to `Install Hyper-V on Windows 10`_ to enable and configure
25 | *Hyper-V* on your machine.
26 |
27 | Create a virtual network
28 | ************************
29 |
30 | Once *Hyper-V* has been enabled on your Windows system, you will need to
31 | create a virtual network in the **Hyper-V Manager**. Refer to the
32 | `Create a virtual network`_ documentation to create and configure
33 | a virtual network.
34 |
35 | Create a virtual machine
36 | ************************
37 |
38 | #. Download and decompress the latest hyperv disk image
39 | :file:`clear-XXXXX-hyperv.img.gz`, where XXXXX is the latest
40 | available version of |CL| from our `Downloads`_ page.
41 |
42 | #. Create a virtual machine using the **Hyper-V Manager**:
43 |
44 | a. Choose **Generation 2** when prompted to *specify VM generation*.
45 | b. Choose **Use an existing virtual hard disk** and browse to find the
46 | :file:`clear-XXXX-hyperv.vhdx` file.
47 | c. When finished, open VM settings, select Firmware Section and in Secure
48 | Boot config, **uncheck** Enable Secure Boot.
49 |
50 | .. note:: Currently, |CL| does not boot with `secure boot`
51 | enabled.
52 |
53 | #. Connect to your new VM and start it. You should see a prompt:
54 |
55 | .. code-block:: console
56 |
57 | > User: root
58 |
59 | #. Set a root user password.
60 |
61 | Your virtual machine running |CL| is ready!
62 |
63 | .. _Windows Server Virtualization: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/about/
64 | .. _Install Hyper-V on Windows 10: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v
65 | .. _Create a virtual network: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network
66 | .. _Downloads: https://cdn.download.clearlinux.org/image/
67 | .. _`Intel® Virtualization Technology`: http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
68 | .. _`Intel® Virtualization Technology for Directed I/O`: https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices
69 |
--------------------------------------------------------------------------------
/source/guides/maintenance/hostname.rst:
--------------------------------------------------------------------------------
1 | .. _hostname:
2 |
3 | Modify hostname
4 | ###############
5 |
6 | This guide describes how to modify and view the hostname of your |CL-ATTR|
7 | system.
8 |
9 | .. contents::
10 | :local:
11 | :depth: 1
12 |
13 | Overview
14 | ********
15 |
16 | By default, |CL| installations have a machine generated name, which is a
17 | long string of letters and numbers. The generated name is fine for computers
18 | but is not human-friendly. Administrators and users will often want to rename
19 | their machines with a name that is easier to remember, type, and search
20 | for. Renaming a machine also makes it easier to identify, by including
21 | meaningful data in the name. The following examples show human-friendly machine
22 | names:
23 |
24 | * *regression-test*
25 | * *sally-test-box1*
26 | * *az-bldg2-lab*
27 |
28 | Set your hostname
29 | *****************
30 |
31 | |CL| uses the :command:`hostnamectl` command to display and modify the machine
32 | name. :command:`hostnamectl` is part of the :command:`os-core` bundle, which
33 | provides a basic Linux\* user space and utilities.
34 |
35 | This example sets the hostname to *telemetry-test-2-h15*, to identify a
36 | |CL| telemetry test machine on the second floor at grid location H15.
37 | Make sure to reboot after setting a new hostname.
38 |
39 | .. code-block:: bash
40 |
41 | sudo hostnamectl set-hostname telemetry-test-2-h15
42 | sudo reboot
43 |
44 | .. note::
45 |
46 | There are three types of hostname: *static*, *transient*, and *pretty*.
47 | The most common is the static hostname. Static hostnames must be between
48 | two and 63 characters long, must start and end with a letter or number,
49 | and may contain letters (case-insensitive), numbers, dashes, or dots.
50 |
51 | If the static hostname exists, it is used to generate the transient hostname,
52 | which is maintained by the kernel. The transient hostname can be changed
53 | by DHCP or mDNS at runtime.
54 |
55 | The pretty hostname is a free-form UTF8 name used for presentation to the user.
56 |
57 | View your hostname
58 | ******************
59 |
60 | View your current hostname using the following command:
61 |
62 | .. code-block:: bash
63 |
64 | hostnamectl
65 |
66 | You should see output similar to:
67 |
68 | .. code-block:: console
69 |
70 | Static hostname : telemetry-test-2-h15
71 | Pretty hostname : telemetry-test-2-h15
72 | Icon name : computer-desktop
73 | Chassis : desktop
74 | Machine ID : 4d0d60207a904ebbab96680a51ac1339
75 | Boot ID : 98d3514e5a984e8cbbdf46a2f0d6b397
76 | Operating System : Clear Linux OS
77 | Kernel : Linux 4.18.8-632.native
78 | Architecture : x86-64
79 |
80 |
81 | **Congratulations!** You successfully modified the hostname of your |CL| system.
82 |
--------------------------------------------------------------------------------
/source/_themes/clearlinux/static/js/project.js:
--------------------------------------------------------------------------------
1 | jQuery(document).ready(function($){
2 |
3 | var classItem = $('.custom-dropdown-menu li.parent-item').attr('class');
4 | if(classItem == 'menu-item-open parent-item') {
5 | $('.custom-dropdown-menu li.parent-item a').append('');
6 | } else {
7 | $('.custom-dropdown-menu li.parent-item a').append('');
8 | }
9 |
10 | $('header .mobile-menu').click(function(){
11 | $(this).parent().toggleClass('menu-open');
12 | $('.o1-logo-container-mobile').toggleClass('menu-open');
13 | $('body').toggleClass('menu-opened');
14 | });
15 |
16 | $('footer .mobile-menu').click(function(){
17 | $(this).parent().toggleClass('menu-open');
18 | });
19 |
20 | $('#block-menu-menu-social-media, #block-menu-menu-get-involved').click(function(){
21 | $(this).find('.menu').slideToggle();
22 | });
23 |
24 | $('.custom-dropdown-menu li.parent-item .fa').click(function(evt){
25 | evt.stopPropagation();
26 | $(this).toggleClass('fa-chevron-up fa-chevron-down');
27 | $(this).closest('li').toggleClass('menu-item-closed menu-item-open');
28 | return false;
29 | });
30 |
31 | $('div[id^=heading-]').click(function(){
32 | var section = $(this).attr('id').replace('heading-', '');
33 | $('#collapse-' + section).slideToggle();
34 | $('#title-'+ section +' a i').toggleClass('fa-plus-square fa-minus-square');
35 | });
36 |
37 | $('header .mobile-menu').click(function(){
38 | $('header').toggleClass('menu-open');
39 | $('.o1-logo-container-mobile').toggleClass('menu-open');
40 | $('body').toggleClass('menu-opened');
41 | });
42 |
43 | $('footer .mobile-menu').click(function(){
44 | $(this).parent().toggleClass('menu-open');
45 | });
46 |
47 | $('div[id^=heading-]').click(function(){
48 | var section = $(this).attr('id').replace('heading-', '');
49 | $('#collapse-' + section).slideToggle();
50 | $('#title-'+ section +' a i').toggleClass('fa-plus-square fa-minus-square');
51 | });
52 |
53 | function onScroll(el) {
54 | var $header = $('.project-header').first();
55 | var scrollTop = $(el.currentTarget).scrollTop();
56 |
57 | if (!$header.hasClass('scrolled') && scrollTop >= 200) {
58 | $header.addClass('scrolled');
59 | }
60 |
61 | if ($header.hasClass('scrolled') && scrollTop < 200) {
62 | $header.removeClass('scrolled');
63 | }
64 | }
65 |
66 | //Hidde mobile menu
67 | $(window).resize(function(event) {
68 | var w = $(window).width();
69 | if(w > 1199) {
70 | $('header').removeClass('menu-open');
71 | }
72 | });
73 |
74 | //Add sortable class to table tag.
75 | var tables = $('table');
76 | $.each(tables, function(index, val) {
77 | $(val).addClass('sortable');
78 | });
79 |
80 | //Animates logo on scroll
81 | $('body, html').scroll(onScroll);
82 | $(window).scroll(onScroll);
83 |
84 | });
85 |
--------------------------------------------------------------------------------
/source/tutorials/archive/kata_migration.rst:
--------------------------------------------------------------------------------
1 | .. _kata_migration:
2 |
3 | Migrate Clear Containers to Kata Containers\*
4 | #############################################
5 |
6 | `Clear Containers`_ and `Kata Containers`_ can co-exist in the same system.
7 | Both can be installed through the :file:`containers-virt bundle`. However, we
8 | recommend that you migrate to Kata Containers because Clear Containers is no
9 | longer maintained_ and will soon be deprecated on |CL-ATTR|.
10 |
11 | This guide describes how to migrate to Kata Containers and assumes that:
12 |
13 | * Clear Containers is on a Docker\* system.
14 | * Kata Containers is installed. See :ref:`kata`.
15 |
16 |
17 | Stop Clear Containers instances
18 | *******************************
19 |
20 | As an unprivileged user, stop all running instances of Clear Containers:
21 |
22 | .. code-block:: bash
23 |
24 | for container in $(sudo docker ps -q); do sudo docker stop $container; done
25 |
26 |
27 | Manually migrate customized configuration files
28 | ***********************************************
29 |
30 | If you have made changes to your `Clear Containers configuration`_, review
31 | those changes and decide whether to manually apply those changes to your
32 | `Kata Containers configuration`_.
33 |
34 | Make any required changes before continuing this process.
35 |
36 | .. note::
37 |
38 | You do not need to manually remove any Clear Containers packages.
39 |
40 |
41 | Enable Kata Containers as default
42 | *********************************
43 |
44 | #. Configure Docker to use the Kata Containers runtime by default.
45 |
46 | .. code-block:: bash
47 |
48 | sudo mkdir -p /etc/systemd/system/docker.service.d/
49 | cat <` can
11 | be used to create a highly customized installation that can even run on a
12 | system with a 128MB of memory and 600MB of disk space, for example.
13 |
14 |
15 | Installer requirements
16 | **********************
17 |
18 | The *live desktop* installer requires at least 1 GB of RAM because more
19 | resources are required to run in live mode than after |CL| is installed onto
20 | persistent storage.
21 |
22 | For hardware with less resources, use the *live server* installer because it
23 | has a smaller memory footprint.
24 |
25 | See https://clearlinux.org/downloads for more download options.
26 |
27 |
28 | System requirements
29 | *******************
30 |
31 | |CL| requires an x86 64-bit processor which supports Intel® Streaming SIMD
32 | Extensions 4.1 (Intel® SSE 4.1), and it requires a system that supports UEFI.
33 |
34 | The |CL| installer performs a system compatibility check upon booting. To
35 | manually verify system compatibility with |CL|, run the :ref:`compatibility
36 | check tool` or go to http://ark.intel.com and check for
37 | these features:
38 |
39 | * Instruction Set:
40 |
41 | - 64-bit
42 |
43 | * Instruction Set Extensions:
44 |
45 | - Supplemental Streaming SIMD Extension 3 (Intel® SSSE3)
46 | - Intel® Streaming SIMD Extensions 4.1 (Intel® SSE 4.1)
47 | - Intel® Streaming SIMD Extensions 4.2 (Intel® SSE 4.2)
48 | - Intel® Advanced Encryption Standard New Instructions (Intel® AES-NI)
49 | - Carry-less Multiplication (PCLMUL)
50 |
51 | The following processor families have been verified to run |CL|:
52 |
53 | * Intel® Core™ Processor Family (2nd generation or greater)
54 | * Intel® Xeon® E3-xxxx processor
55 | * Intel® Xeon® E5-xxxx processor
56 | * Intel® Xeon® E7-xxxx processor
57 | * Intel® Atom® processor C Series
58 | * Intel® Atom® processor E Series
59 |
60 |
61 | Recommended configurations
62 | **************************
63 |
64 | For general |CL| desktop use the recommended minimum requirements include:
65 |
66 | ========= ===============================
67 | Component Configuration
68 | --------- -------------------------------
69 | Processor Compatible x86 64-bit processor
70 | --------- -------------------------------
71 | Memory 4GB RAM
72 | --------- -------------------------------
73 | Disk 20 GB
74 | --------- -------------------------------
75 | Graphics Device with openGL support (e.g. Intel HD/UHD Graphics)
76 | --------- -------------------------------
77 | Network Active Internet connection
78 | ========= ===============================
79 |
80 |
--------------------------------------------------------------------------------
/source/reference/image-types.rst:
--------------------------------------------------------------------------------
1 | .. _image-types:
2 |
3 | |CL-ATTR| image types
4 | #########################
5 |
6 | .. _image-types-content:
7 |
8 | |CL-ATTR| offers many types of `images`_ for different platforms and environments.
9 |
10 | .. _incl-image-filename:
11 |
12 | The naming convention of a |CL| image filename is:
13 |
14 | .. code-block:: console
15 |
16 | clear-[version number]-[image type].[compression type]
17 |
18 | * The *[version number]* field specifies the version number.
19 |
20 | * The *[image type]* field specifies the type of image and its corresponding
21 | file format.
22 |
23 | * The *[compression type]* field specifies the compression type. Two types of
24 | compressions are used: GNU\* zip (*.gz*) and XZ (*.xz*).
25 |
26 | .. _incl-image-filename-end:
27 |
28 | Table 1 lists the currently available images that are platform independent.
29 | Table 2 lists the currently available images that are platform specific.
30 |
31 | .. list-table:: Table 1: Types of platform-independent |CL| images
32 | :widths: 15, 85
33 | :header-rows: 1
34 |
35 | * - Image Type
36 | - Description
37 |
38 | * - live-desktop.img or live-desktop.iso
39 | - Image for booting to GNOME\* desktop to preview or install the OS.
40 |
41 | * - live-server.img or live-server.iso
42 | - Image for booting to server command prompt to preview or install the OS.
43 |
44 | .. list-table:: Table 2: Types of platform-specific |CL| images
45 | :widths: 15, 85
46 | :header-rows: 1
47 |
48 | * - Image Type
49 | - Description
50 |
51 | * - aws.img
52 | - Image suitable for use with Amazon\* AWS\*.
53 |
54 | * - azure.vhd
55 | - Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform.
56 |
57 | * - azure-docker.vhd
58 | - Virtual Hard Disk for use on Microsoft Azure cloud platform with Docker\* pre-installed.
59 |
60 | * - azure-machine-learning.vhd
61 | - Virtual Hard Disk for use on Microsoft Azure cloud platform with the `machine-learning-basic` bundle installed.
62 |
63 | * - cloudguest.img
64 | - Image with generic cloud guest virtual machine (VM) requirements installed.
65 |
66 | * - gce.tar
67 | - Image with the Google Compute Engine (GCE) specific kernel.
68 |
69 | * - hyperv.vhdx
70 | - Virtual Hard Disk for use with Microsoft Hyper-V\* hypervisor. Includes `optimized kernel`_ for Hyper-V.
71 |
72 | * - kvm.img
73 | - Image for booting in a simple VM with start_qemu.sh. Includes
74 | `optimized kernel`_ for KVM.
75 |
76 | * - kvm-legacy.img
77 | - Image for booting in a simple VM using legacy BIOS, if using start_qemu.sh make sure to remove -bios parameter.
78 |
79 | * - pxe.tar
80 | - Image suitable for use with PXE server.
81 |
82 | * - vmware.vmdk
83 | - Virtual Machine Disk for VMware\* platforms inclduing Player, Workstation, and ESXi.
84 |
85 | .. _images: https://clearlinux.org/downloads
86 | .. _`optimized kernel`: https://clearlinux.org/documentation/clear-linux/reference/compatible-kernels
87 |
88 |
--------------------------------------------------------------------------------
/source/guides/maintenance/architect-lifecycle.rst:
--------------------------------------------------------------------------------
1 | .. _architect-lifecycle:
2 |
3 | Architect the life-cycle of |CL-ATTR|
4 | #####################################
5 |
6 | This guide describes the basic, recommended infrastructure and workflow for
7 | maintaining a |CL-ATTR| derivative.
8 |
9 | .. contents::
10 | :local:
11 | :depth: 1
12 |
13 | Prerequisites
14 | *************
15 |
16 | * A repository with software RPM artifacts and a CI/CD system with a |CL|
17 | machine for building `mixes`
18 |
19 | * Experience using :ref:`mixer ` to create a |CL|-based distro
20 |
21 | * Experience using :ref:`swupd ` for maintaining the |CL|
22 | build environment
23 |
24 | * Familiarity with |CL| architecture and reuse of its content in releases
25 |
26 | Description
27 | ***********
28 |
29 | Maintaining a |CL| derivative requires:
30 |
31 | * Monitoring upstream |CL| for new releases
32 | * Building software packages and staging
33 | * Employing CI/CD automation for building releases
34 | * Integrating Quality Assurance for testing and validation
35 |
36 | Coordinated infrastructure is deployed to automate the life-cycle
37 | of your |CL| derivative. We divide deployment of this infrastucture in two
38 | parts: *Content Workflow*; and *Release Workflow*, shown in Figure 1.
39 |
40 | .. figure:: figures/architect-lifecycle-1.png
41 | :scale: 100%
42 | :alt: Architect the life-cycle
43 |
44 | Figure 1: Architect the life-cycle
45 |
46 | Content Workflow
47 | ****************
48 |
49 | The Content Workflow (Figure 1) orchestrates the processes used to manage
50 | the creation of content for the distribution. This includes everything from
51 | detecting a new release in a custom software repository to generating RPM
52 | package files. The RPM files serve as intermediary artifacts that track software
53 | dependencies and provide file-level data consumed in a Release Workflow. The
54 | `Watcher Pipeline`_ checks |CL| and a content provider, such as Koji, to
55 | determine if a new release is necessary.
56 |
57 | Release Workflow
58 | ****************
59 |
60 | The Release Workflow (Figure 1) gathers the content of the RPMs and
61 | ensures it can be consumed by :ref:`mixer `. A content web server
62 | hosts the |CL| derivative, to which targets connect for updating their OSes.
63 | As an integral part of this toolchain, the `Release Pipeline`_ enables these
64 | derivatives to incorporate |CL| content into their own custom
65 | content. The Watcher Pipeline triggers the Release Pipeline to create
66 | new releases.
67 |
68 | Implementation
69 | **************
70 |
71 | The |CL| Distro Factory manages the Release Workflow. For detailed information
72 | about Distro Factory deployment, refer to the `clr-distro-factory`_ GitHub\* repo.
73 |
74 | .. _clr-distro-factory: https://github.com/clearlinux/clr-distro-factory/wiki#clear-linux-distro-factory
75 |
76 | .. _Release Pipeline: https://github.com/clearlinux/clr-distro-factory/wiki/Release
77 |
78 | .. _Watcher Pipeline: https://github.com/clearlinux/clr-distro-factory/wiki/Watcher
79 |
--------------------------------------------------------------------------------
/source/guides/maintenance/developer-workstation.rst:
--------------------------------------------------------------------------------
1 | .. _developer-workstation:
2 |
3 | Developer Workstation
4 | #####################
5 |
6 | This guide helps you find the minimum set of bundles needed to start your
7 | |CL-ATTR| development project.
8 |
9 | Before continuing, review the :ref:`swupd ` guide to learn more
10 | about the swupd tool and how |CL| simplifies software versioning compared to
11 | other Linux\* distributions.
12 |
13 | .. contents::
14 | :local:
15 | :depth: 1
16 |
17 | Workstation Setup
18 | *****************
19 |
20 | After installing the minimum set of bundles required to get started, you can add
21 | more bundles relevant to your specific use case.
22 |
23 | To run any process required for |CL| development, you can add the large bundle
24 | :ref:`*os-clr-on-clr* `. However, given how many packages this
25 | bundle contains, you may want to deploy a leaner OS with only bundles relevant to
26 | your project.
27 |
28 | Use Table 1, *Developer Profiles*, to identify the *minimum
29 | required bundles* to get started developing based on your role or project.
30 | While your role may not neatly fit in one of these categories, consider
31 | Table 1 as a starting point.
32 |
33 | .. list-table:: **Table 1. Developer Profiles**
34 | :widths: 20, 20, 20, 20
35 | :header-rows: 1
36 |
37 | * - |CL| Bundle
38 | - *Internet of Things (IoT)*
39 | - *System Administrator*
40 | - *Client/Cloud/Web Developer*
41 |
42 | * - :command:`editors`
43 | - ✓
44 | - ✓
45 | - ✓
46 |
47 | * - :command:`network-basic`
48 | - ✓
49 | - ✓
50 | - ✓
51 |
52 | * - :command:`openssh-server`
53 | - ✓
54 | - ✓
55 | - ✓
56 |
57 | * - :command:`webserver-basic`
58 | -
59 | - ✓
60 | - ✓
61 |
62 | * - :command:`application-server`
63 | -
64 | - ✓
65 | - ✓
66 |
67 | * - :command:`database-basic`
68 | -
69 | - ✓
70 | - ✓
71 |
72 | * - :command:`desktop-autostart`
73 | - ✓
74 | - ✓
75 | - ✓
76 |
77 | * - :command:`dev-utils`
78 | -
79 | -
80 | - ✓
81 |
82 | swupd search
83 | ************
84 |
85 | We recommend learning about :ref:`swupd `, to learn the
86 | commands to search for and add bundles relevant to your project.
87 |
88 | The guide provides an :ref:`example `
89 | that shows you how to:
90 |
91 | * Use swupd to search for bundles
92 | * Use swupd to add bundles
93 |
94 | Core Concepts
95 | *************
96 |
97 | We recommend that you understand these core concepts in |CL| *before*
98 | developing your project.
99 |
100 | * :ref:`Software update `
101 | * :ref:`Mixer `
102 | * :ref:`Autospec `
103 |
104 | Other resources for developers
105 | -----------------------------------
106 |
107 | * `Developer Tooling Framework`_ for |CL|
108 | * `Bundle Definition Files`_
109 |
110 | .. _Bundle Definition Files: https://github.com/clearlinux/clr-bundles
111 |
112 | .. _Developer Tooling Framework: https://github.com/clearlinux/common
113 |
--------------------------------------------------------------------------------
/source/guides/clear/debug.rst:
--------------------------------------------------------------------------------
1 | .. _debug:
2 |
3 | Debug system
4 | ############
5 |
6 | |CL-ATTR| introduces a novel approach to system software debugging using
7 | *clr-debug-info*. On the client side, the |CL| debug system obtains any
8 | necessary debug information on-the-fly over a network during a debugging
9 | session. On the server side, the system curates and compresses debug
10 | information into small pieces for efficient downloading.
11 |
12 | For developers, this avoids the interruption during debugging that usually
13 | happens when debug information is missing. This can be especially useful on
14 | systems where storage is limited.
15 |
16 |
17 | .. contents:: :local:
18 | :depth: 2
19 |
20 |
21 | Background
22 | ----------
23 |
24 | Software that is compiled and packaged for general usage in an operating
25 | system typically only contains components that are used to execute the
26 | program, such as binaries and libraries. Extra developer data, such as the
27 | actual source code and symbol information, are separated and excluded for
28 | efficiency.
29 |
30 | The debug information helps relate binary code to human readable source code
31 | lines and variables. Most of the time, this auxiliary information
32 | is not needed;
33 | however without it, debugging a program results in limited visibility.
34 |
35 |
36 | Usage
37 | -----
38 |
39 | The clr-debug-info system is integrated into |CL| and seamlessly engages once
40 | installed.
41 |
42 | #. Install the *dev-utils* bundle.
43 |
44 | .. code:: bash
45 |
46 | sudo swupd bundle-add dev-utils
47 |
48 | .. note::
49 |
50 | The *telemetrics* and *performance-tools* bundles also include
51 | clr-debug-info.
52 |
53 |
54 | #. Start a debugging session against a program using a debugger, such as GDB.
55 | For example, to debug *gnome-control-center* execute the following
56 | command:
57 |
58 | .. code:: bash
59 |
60 | gdb /usr/bin/gnome-control-center
61 |
62 | As you step through the program and debug information is needed, the
63 | clr_debug_daemon obtains it in the background.
64 |
65 |
66 | Implementation
67 | --------------
68 |
69 | The implementation of the |CL| debug system is open source and available on
70 | GitHub at: https://github.com/clearlinux/clr-debug-info/
71 |
72 | .. figure:: figures/debug-diagram.png
73 | :width: 400px
74 | :alt: Debug system communication flow
75 |
76 | Figure 1: The communication flow of the |CL| debug system
77 |
78 | The |CL| debug system implements a :abbr:`FUSE (filesystem in userspace)`
79 | filesystem mounted at :file:`/usr/lib/debug` and :file:`/usr/src/debug`. The
80 | FUSE filesystem starts automatically. You can verify its status by executing
81 | :command:`systemctl status clr_debug_fuse.service`.
82 |
83 | The *clr_debug_daemon* is responsible for fetching the appropriate package
84 | debug content from the server and making it available for any debugging
85 | programs that need it. It is socket activated whenever a request to the local
86 | FUSE filesystem occurs. You can verify its status with :command:`systemctl
87 | status clr_debug_daemon.service`.
88 |
89 |
90 | |CL| hosts debuginfo content packaged for consumption by |CL| debug clients at
91 | https://download.clearlinux.org/debuginfo/
92 |
--------------------------------------------------------------------------------
/source/guides/maintenance/enable-user-space.rst:
--------------------------------------------------------------------------------
1 | .. _enable-user-space:
2 |
3 | Create and enable a new user space
4 | ##################################
5 |
6 | This guide provides steps to complete the following basic setup tasks for
7 | a newly installed |CL-ATTR| system:
8 |
9 | .. contents::
10 | :local:
11 | :depth: 1
12 |
13 | Create a new user
14 | *****************
15 |
16 | To create a new user and set a password for that user, enter the following
17 | commands as a root user:
18 |
19 | .. code-block:: bash
20 |
21 | useradd
22 | passwd
23 |
24 | Replace the with the name of the user account you want to create
25 | including the password for that user. The :command:`passwd` command prompts
26 | you to enter a new password. Retype the new password for the new user
27 | account just created.
28 |
29 | Add the new user to the *wheel* group
30 | *************************************
31 |
32 | Before logging off as root and logging into your new user account,
33 | enable the :command:`sudo` command for your new .
34 |
35 | To be able to execute all applications with root privileges, add the
36 | to the `wheel group`_.
37 |
38 | #. Add to the wheel group:
39 |
40 | .. code-block:: bash
41 |
42 | usermod -G wheel -a
43 |
44 | #. Log out of root and into the new .
45 |
46 | To log off as root, enter :command:`exit`.
47 |
48 | #. Enter the new and the password created earlier.
49 |
50 | You will now be in the home directory of .
51 |
52 | Install and update the OS software to its current version
53 | *********************************************************
54 |
55 | The |CL| software utility :ref:`swupd ` allows you to perform
56 | system updates while reaping the benefits of upstream development.
57 |
58 | To update your newly installed OS, run:
59 |
60 | .. code-block:: bash
61 |
62 | sudo swupd update
63 |
64 | Add a bundle
65 | ************
66 |
67 | Software applications are installed as bundles using the command
68 | :command:`swupd bundle-add`. Experienced Linux users might compare swupd
69 | to running :command:`apt-get` or :command:`yum install` for package
70 | management. However |CL| manages packages at the level of bundles, which
71 | are integrated stacks of packages.
72 |
73 | For example, the :command:`sysadmin-basic` bundle installs the majority of
74 | applications useful to a system administrator. To install it, enter:
75 |
76 | .. code-block:: bash
77 |
78 | swupd bundle-add sysadmin-basic
79 |
80 | View a full list of bundles and packages installed with the `sysadmin-basic`_
81 | bundle. You can also view all `bundles`_ for |CL|, active or deprecated.
82 |
83 | Expand your knowledge of :command:`swupd` and check out our developer resources:
84 |
85 | * :ref:`swupd-guide`
86 | * :ref:`developer-workstation`
87 |
88 | Next steps
89 | **********
90 |
91 | Check out our guides and tutorials.
92 |
93 | * :ref:`guides`
94 | * :ref:`tutorials`
95 |
96 | .. _`sysadmin-basic`:
97 | https://github.com/clearlinux/clr-bundles/blob/master/bundles/sysadmin-basic
98 |
99 | .. _`bundles`:
100 | https://github.com/clearlinux/clr-bundles/tree/master/bundles
101 |
102 | .. _`wheel group`:
103 | https://en.wikipedia.org/wiki/Wheel_(Unix_term)
104 |
--------------------------------------------------------------------------------
/source/reference/collaboration/collaboration.rst:
--------------------------------------------------------------------------------
1 | .. _collaboration:
2 |
3 | Documentation guidelines
4 | ########################
5 |
6 | See a missing topic in the documentation? Find an existing document that could
7 | be improved? Help us out by contributing! If you haven't contributed before,
8 | take a moment to review our `Contribution guidelines`_.
9 |
10 | Do you have questions about the documentation that were not answered by these
11 | guidelines? Send your question to the `mailing list`_.
12 |
13 | Contribution guidelines
14 | ***********************
15 |
16 | The |CL| documentation is hosted in GitHub and is written using
17 | reStructuredText. Use our guidelines and best practices to write consistent,
18 | readable documentation.
19 |
20 | .. toctree::
21 | :maxdepth: 1
22 |
23 | Writing guide: Describes the style we use to keep our documents clear and concise.
24 | Structure and formatting guide: Explains how we organize and format content, using reStructuredText and Sphinx.
25 |
26 | How to contribute
27 | *****************
28 |
29 | There are multiple ways to contribute and help improve our documentation:
30 |
31 | * **Make a suggestion**: Have a documentation suggestion but no time to write it
32 | yourself? Send your suggestion to the `mailing list`_.
33 | * **Log an issue**: If you find a problem in our documentation (such as typos or
34 | out-of-date information), log an issue in the `documentation repository`_.
35 | * **Contribute directly via GitHub**: Whether you've found a typo, have better
36 | instructions or examples, or have a new page to add, submit your improvement
37 | or addition as a pull request on the `documentation repository`_.
38 | * **Test documentation**: Step through our instructional guides and tutorials to
39 | verify the instructions. Log or correct any out-of-date information.
40 |
41 | All contributions must follow our `code of conduct`_.
42 |
43 | Contribute via GitHub
44 | *********************
45 |
46 | Our documentation is hosted in GitHub and we follow the standard `GitHub flow`_:
47 |
48 | #. Clone the `documentation repository`_.
49 |
50 | #. Create your own fork of the repository.
51 |
52 | #. Create a branch for your contribution.
53 |
54 | #. Add your commits.
55 |
56 | #. Open a pull request.
57 |
58 | #. Discuss, review, and update your contributions.
59 |
60 | #. Once the maintainer approves, your contribution is merged and published as
61 | part of the documentation.
62 |
63 | .. _references:
64 |
65 | References
66 | **********
67 |
68 | We use the following references to guide the grammar, style, and formatting of
69 | our documentation:
70 |
71 | * `Microsoft Writing Style Guide`_
72 | * `Merriam-Webster Dictionary`_
73 | * The Chicago Manual of Style (15th edition), The University of Chicago Press
74 | * Microsoft Press Computer Dictionary, Microsoft Press
75 | * Read Me First!, Oracle Technical Publications
76 |
77 |
78 | .. _`code of conduct`: https://clearlinux.org/community/code-of-conduct
79 | .. _mailing list: https://lists.clearlinux.org/mailman/listinfo/dev
80 | .. _GitHub flow: https://guides.github.com/introduction/flow/
81 | .. _documentation repository: https://github.com/clearlinux/clear-linux-documentation
82 | .. _Microsoft Writing Style Guide: https://docs.microsoft.com/en-us/style-guide/welcome/
83 | .. _Merriam-Webster Dictionary: https://www.merriam-webster.com/
--------------------------------------------------------------------------------
/locale/zh_CN/LC_MESSAGES/guides/maintenance/time.po:
--------------------------------------------------------------------------------
1 | # SOME DESCRIPTIVE TITLE.
2 | # Copyright (C) 2019, many
3 | # This file is distributed under the same license as the Clear Linux*
4 | # Project Docs package.
5 | # FIRST AUTHOR , 2019.
6 | #
7 | msgid ""
8 | msgstr "Project-Id-Version: Clear Linux* Project Docs latest\n"
9 | "Report-Msgid-Bugs-To: \n"
10 | "POT-Creation-Date: 2019-07-22 12:54-0700\n"
11 | "PO-Revision-Date: 2019-09-04 16:21-0008\n"
12 | "Last-Translator: FULL NAME \n"
13 | "Language-Team: zh-Hans\n"
14 | "MIME-Version: 1.0\n"
15 | "Content-Type: text/plain; charset=utf-8\n"
16 | "Content-Transfer-Encoding: 8bit\n"
17 | "Generated-By: Intel® International Developer Studio Version 4.1.273.0\n"
18 | "Language: zh-Hans\n"
19 |
20 | #: ../../guides/maintenance/time.rst:4
21 | msgid "Set the time"
22 | msgstr "设置时间"
23 |
24 | #: ../../guides/maintenance/time.rst:6
25 | msgid ""
26 | "This guide describes how to reset the time in your |CL-ATTR| system when "
27 | "the default :abbr:`NTP (Network Time Protocol)` servers cannot be "
28 | "reached."
29 | msgstr "本指南介绍了当无法访问默认 :abbr:`NTP (Network Time Protocol)` 服务器时，如何重置 |CL-ATTR| 系统中的时间。"
30 |
31 | #: ../../guides/maintenance/time.rst:9
32 | msgid "|CL| uses the `systemd-timesyncd.service` daemon to synchronize time."
33 | msgstr "|CL| 使用 `systemd-timesyncd.service` 守护程序来同步时间。"
34 |
35 | #: ../../guides/maintenance/time.rst:12
36 | msgid "Install the :command:`sysadmin-basic` bundle."
37 | msgstr "安装 :command:`sysadmin-basic` 捆绑包。"
38 |
39 | #: ../../guides/maintenance/time.rst:18
40 | msgid "Set your time zone. This example uses Los Angeles."
41 | msgstr "设置时区。此示例中使用了洛杉矶。"
42 |
43 | #: ../../guides/maintenance/time.rst:26
44 | msgid ""
45 | "To see a list of time zones, use the command: :command:`timedatectl list-"
46 | "timezones | grep `"
47 | msgstr "要查看时区列表，请使用 :command:`timedatectl list-timezones | grep ` 命令"
48 |
49 | #: ../../guides/maintenance/time.rst:29
50 | msgid "Create a :file:`/etc/systemd/` directory."
51 | msgstr "创建一个 :file:`/etc/systemd/` 目录。"
52 |
53 | #: ../../guides/maintenance/time.rst:35
54 | msgid ""
55 | "Create a new file named :file:`/etc/systemd/timesyncd.conf` and enter the"
56 | " following text."
57 | msgstr "创建一个名为 :file:`/etc/systemd/timesyncd.conf` 的新文件，并输入以下文本。"
58 |
59 | #: ../../guides/maintenance/time.rst:44
60 | msgid "Enable the `systemd-timesyncd` service."
61 | msgstr "启用 `systemd-timesyncd` 服务。"
62 |
63 | #: ../../guides/maintenance/time.rst:52
64 | msgid ""
65 | "To check the service status, use the :command:`timedatectl status` "
66 | "command."
67 | msgstr "要检查服务状态，请使用 :command:`timedatectl status` 命令。"
68 |
69 | #: ../../guides/maintenance/time.rst:54
70 | msgid ""
71 | "To restart the `timesyncd` daemon, enter :command:`systemctl restart "
72 | "systemd-timesyncd` into your terminal emulator."
73 | msgstr "要重启 `timesyncd` 守护程序，请在终端仿真器中输入 :command:`systemctl restart systemd-timesyncd`。"
74 |
75 | #: ../../guides/maintenance/time.rst:57
76 | msgid "**Congratulations!** You successfully set up the time in your |CL| system."
77 | msgstr "祝贺您！您成功地在 |CL| 系统中设置了时间。"
78 |
79 | #~ msgid ""
80 | #~ "|CL-ATTR| uses the `systemd-"
81 | #~ "timesyncd.service` daemon to synchronize time."
82 | #~ msgstr ""
83 |
84 | #~ msgid ""
85 | #~ "This guide describes how to reset "
86 | #~ "the time in your |CL| system when"
87 | #~ " the default :abbr:`NTP (Network Time "
88 | #~ "Protocol)` servers cannot be reached."
89 | #~ msgstr ""
90 |
91 | #~ msgid "Install the `sysadmin-basic` bundle."
92 | #~ msgstr ""
93 |
94 |
95 |
96 |
--------------------------------------------------------------------------------
/locale/zh_CN/LC_MESSAGES/guides/clear/bundles.po:
--------------------------------------------------------------------------------
1 | # SOME DESCRIPTIVE TITLE.
2 | # Copyright (C) 2019, many
3 | # This file is distributed under the same license as the Clear Linux*
4 | # Project Docs package.
5 | # FIRST AUTHOR , 2019.
6 | #
7 | msgid ""
8 | msgstr "Project-Id-Version: Clear Linux* Project Docs latest\n"
9 | "Report-Msgid-Bugs-To: \n"
10 | "POT-Creation-Date: 2019-08-09 14:33-0700\n"
11 | "PO-Revision-Date: 2019-09-04 16:21-0008\n"
12 | "Last-Translator: FULL NAME \n"
13 | "Language-Team: zh-Hans\n"
14 | "MIME-Version: 1.0\n"
15 | "Content-Type: text/plain; charset=utf-8\n"
16 | "Content-Transfer-Encoding: 8bit\n"
17 | "Generated-By: Intel® International Developer Studio Version 4.1.273.0\n"
18 | "Language: zh-Hans\n"
19 |
20 | #: ../../guides/clear/bundles.rst:4
21 | msgid "Bundles"
22 | msgstr "bundle 文件"
23 |
24 | #: ../../guides/clear/bundles.rst:6
25 | msgid ""
26 | "Linux-based operating systems contain the code of several hundred, if not"
27 | " thousands, of open source projects. To make this manageable, "
28 | "distributions use a concept called \"packages\" to configure and compile "
29 | "the source code of these projects into binaries."
30 | msgstr "基于 Linux 的操作系统包含数百甚至数千个开源项目的代码。为了便于管理，发行版使用了一个名为 \"packages\" 的概念来配置这些项目的源代码并将其编译成二进制代码。"
31 |
32 | #: ../../guides/clear/bundles.rst:11
33 | msgid ""
34 | "Many distributions then split the content of these compiled packages into"
35 | " so-called sub-packages, which are the granularity at which these "
36 | "distributions deploy their software. With those kinds of distributions, "
37 | "system administrators can then install and update sub-packages "
38 | "individually or as a set, using tools such as \"yum\" and \"apt-get.\""
39 | msgstr "许多发行版随后将这些编译包的内容分成所谓的子包，这些子包是这些发行版部署其软件的粒度。借助这些类型的发行版，系统管理员就可以使用 \"yum\" 和 \"apt-get.\" 等工具单独或按组安装和更新子包。"
40 |
41 | #: ../../guides/clear/bundles.rst:17
42 | msgid ""
43 | "The |CL-ATTR| takes a slightly different approach. While we also use the "
44 | "concept of packages to manage compiling source code into binaries, we do "
45 | "not use the package concept to deploy software. Instead, we provide "
46 | "software \"bundles\" that are installed and managed using :ref:`swupd"
47 | "`. Each bundle contains as many or as few open source "
48 | "projects needed to provide a complete functionality."
49 | msgstr "|CL-ATTR| 采用的方法稍有不同。虽然我们也使用包的概念来管理将源代码编译成二进制代码的事宜，但是我们不使用包的概念来部署软件。相反，我们提供软件 \"bundles\"，它是使用 :ref:`swupd` 进行安装和管理的。每个捆绑包都包含或多或少的开源项目以提供完整功能。"
50 |
51 | #: ../../guides/clear/bundles.rst:25
52 | msgid "Related topics"
53 | msgstr "相关主题"
54 |
55 | #: ../../guides/clear/bundles.rst:27
56 | msgid ":ref:`swupd-guide`"
57 | msgstr ":ref:`swupd-guide`"
58 |
59 | #~ msgid ""
60 | #~ "The |CL-ATTR| takes a slightly "
61 | #~ "different approach. While we also use"
62 | #~ " the concept of packages to manage"
63 | #~ " compiling source code into binaries, "
64 | #~ "we do not use the package concept"
65 | #~ " to deploy software. Instead, we "
66 | #~ "provide software \"bundles\" that are "
67 | #~ "installed and managed using :ref:`swupd"
68 | #~ "`. Each bundle contains as "
69 | #~ "many or as few open source "
70 | #~ "projects needed to provide a complete"
71 | #~ " functionality."
72 | #~ msgstr ""
73 |
74 | #~ msgid "Next steps"
75 | #~ msgstr ""
76 |
77 | #~ msgid "To put this concept into practice, see the following resources:"
78 | #~ msgstr ""
79 |
80 | #~ msgid ":ref:`bundles`"
81 | #~ msgstr ""
82 |
83 | #~ msgid ":ref:`bundle-commands`"
84 | #~ msgstr ""
85 |
86 | #~ msgid ":ref:`compatible-kernels`"
87 | #~ msgstr ""
88 |
89 |
90 |
--------------------------------------------------------------------------------
/source/tutorials/proxy.rst:
--------------------------------------------------------------------------------
1 | .. _tutorial-proxy:
2 |
3 | Proxy configuration
4 | ###################
5 |
6 | This tutorial shows you how to configure your system for use behind an
7 | outbound proxy to access the Internet.
8 |
9 | |CL| applications already benefit from the :ref:`autoproxy`
10 | feature.
11 |
12 | .. contents::
13 | :local:
14 | :depth: 1
15 |
16 | Prerequisites
17 | *************
18 |
19 | This tutorial assumes you have installed |CL| on your host system.
20 | For detailed instructions on installing |CL| on a bare metal system, visit
21 | the :ref:`bare metal installation guide `.
22 |
23 | Shells and programs in a desktop session
24 | ****************************************
25 |
26 | Terminal
27 | ========
28 |
29 | Add the following to your ~/.bashrc:
30 |
31 | .. code-block:: bash
32 |
33 | export http_proxy=http://your.http-proxy.url:port
34 | export https_proxy=http://your.https-proxy.url:port
35 | export ftp_proxy=http://your.ftp-proxy.url:port
36 | export socks_proxy=http://your.socks-proxy.url:port
37 | export no_proxy=".your-company-domain.com,localhost"
38 | export HTTP_PROXY=$http_proxy
39 | export HTTPS_PROXY=$https_proxy
40 | export FTP_PROXY=$ftp_proxy
41 | export SOCKS_PROXY=$socks_proxy
42 | export NO_PROXY=$no_proxy
43 |
44 | wget
45 | ****
46 |
47 | Run this command to enable downloading from websites from the terminal:
48 |
49 | .. code-block:: bash
50 |
51 | echo >> ~/.wgetrc <, 2019.
6 | #
7 | #, fuzzy
8 | msgid ""
9 | msgstr ""
10 | "Project-Id-Version: Clear Linux* Project Docs latest\n"
11 | "Report-Msgid-Bugs-To: \n"
12 | "POT-Creation-Date: 2019-07-12 12:18-0700\n"
13 | "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
14 | "Last-Translator: FULL NAME \n"
15 | "Language-Team: LANGUAGE \n"
16 | "MIME-Version: 1.0\n"
17 | "Content-Type: text/plain; charset=utf-8\n"
18 | "Content-Transfer-Encoding: 8bit\n"
19 | "Generated-By: Babel 2.7.0\n"
20 |
21 | #: ../../tutorials/kata_migration.rst:4
22 | msgid "Migrate Clear Containers to Kata Containers\\*"
23 | msgstr ""
24 |
25 | #: ../../tutorials/kata_migration.rst:6
26 | msgid ""
27 | "`Clear Containers`_ and `Kata Containers`_ can co-exist in the same "
28 | "system. Both can be installed through the :file:`containers-virt bundle`."
29 | " However, we recommend that you migrate to Kata Containers because Clear "
30 | "Containers is no longer maintained_ and will soon be deprecated on |CL-"
31 | "ATTR|."
32 | msgstr ""
33 |
34 | #: ../../tutorials/kata_migration.rst:11
35 | msgid "This guide describes how to migrate to Kata Containers and assumes that:"
36 | msgstr ""
37 |
38 | #: ../../tutorials/kata_migration.rst:13
39 | msgid "Clear Containers is on a Docker\\* system."
40 | msgstr ""
41 |
42 | #: ../../tutorials/kata_migration.rst:14
43 | msgid "Kata Containers is installed. See :ref:`kata`."
44 | msgstr ""
45 |
46 | #: ../../tutorials/kata_migration.rst:18
47 | msgid "Stop Clear Containers instances"
48 | msgstr ""
49 |
50 | #: ../../tutorials/kata_migration.rst:20
51 | msgid "As an unprivileged user, stop all running instances of Clear Containers:"
52 | msgstr ""
53 |
54 | #: ../../tutorials/kata_migration.rst:28
55 | msgid "Manually migrate customized configuration files"
56 | msgstr ""
57 |
58 | #: ../../tutorials/kata_migration.rst:30
59 | msgid ""
60 | "If you have made changes to your `Clear Containers configuration`_, "
61 | "review those changes and decide whether to manually apply those changes "
62 | "to your `Kata Containers configuration`_."
63 | msgstr ""
64 |
65 | #: ../../tutorials/kata_migration.rst:34
66 | msgid "Make any required changes before continuing this process."
67 | msgstr ""
68 |
69 | #: ../../tutorials/kata_migration.rst:38
70 | msgid "You do not need to manually remove any Clear Containers packages."
71 | msgstr ""
72 |
73 | #: ../../tutorials/kata_migration.rst:42
74 | msgid "Enable Kata Containers as default"
75 | msgstr ""
76 |
77 | #: ../../tutorials/kata_migration.rst:44
78 | msgid "Configure Docker to use the Kata Containers runtime by default."
79 | msgstr ""
80 |
81 | #: ../../tutorials/kata_migration.rst:54
82 | msgid "Restart the Docker systemd services."
83 | msgstr ""
84 |
85 | #: ../../tutorials/kata_migration.rst:61
86 | msgid "Verify Docker is using Kata Containers."
87 | msgstr ""
88 |
89 | #: ../../tutorials/kata_migration.rst:69
90 | msgid "Run Kata Containers"
91 | msgstr ""
92 |
93 | #: ../../tutorials/kata_migration.rst:71
94 | msgid "Use the following command:"
95 | msgstr ""
96 |
97 | #: ../../tutorials/kata_migration.rst:77
98 | msgid "**Congratulations!**"
99 | msgstr ""
100 |
101 | #: ../../tutorials/kata_migration.rst:79
102 | msgid "You've successfully migrated from Clear Containers to Kata Containers."
103 | msgstr ""
104 |
105 |
--------------------------------------------------------------------------------
/source/guides/clear/ister.rst:
--------------------------------------------------------------------------------
1 | .. _ister:
2 |
3 | ister.py image builder
4 | ######################
5 |
6 | The `ister.py`_ tool is a template-based installer used by |CL-ATTR| to produce
7 | images for each release. The same ister tool is available for use in |CL| to
8 | create custom images based on an upstream image.
9 |
10 | .. contents::
11 | :local:
12 | :depth: 1
13 |
14 | Description
15 | ***********
16 |
17 | |CL| is a rolling release and produces an average of 10 releases per week using the
18 | ister tool. With each release, we produce multiple
19 | :ref:`image types for different environments ` and use cases such
20 | as installers, Hyper-V, KVM, or VMWare.
21 |
22 | Each image has a JSON configuration file that is used by ister to generate the
23 | image. These JSON configuration files describe the image type, partitions, version,
24 | and bundles that will be preinstalled by default with the image. For each image
25 | type we produce, the corresponding JSON configuration file for the image also is
26 | published.
27 |
28 | The :ref:`mixer` tool also uses ister to build images for your custom
29 | mix. Like upstream images, a JSON configuration file is defined for the image,
30 | which ister uses to generate the image. Refer to the :ref:`mixer` guide
31 | for instructions on using ister to build an image for a custom mix.
32 |
33 | Examples
34 | ********
35 |
36 | Recreate an upstream image
37 | ==========================
38 |
39 | The published configuration files for upstream images may be used to recreate an
40 | image. Here are some examples:
41 |
42 | * Use an older version of |CL| and the image is no longer available (only after
43 | March 2017).
44 | * Customize the partitions of an image.
45 | * Customize the bundles preinstalled in an image.
46 | * Run your own post installation script.
47 |
48 |
49 | Follow these steps to recreate an upstream image based on the image's JSON
50 | configuration file:
51 |
52 | #. Install the :command:`os-installer` bundle. Refer to :ref:`swupd-guide` for
53 | more information on installing bundles.
54 |
55 | #. Download the `ister.py`_ tool and grant it sudo privileges.
56 |
57 | #. Download the JSON configuration file for the desired image (located in
58 | :file:`config/image/`):
59 |
60 | * `Current release`_
61 | * `Previous releases`_ (only after March 2017)
62 |
63 | For a previous release, navigate to `Previous releases`_, select the version
64 | you want, and find the JSON configuration file under
65 | :file:`/clear/config/image`. For example:
66 | ``https://cdn.download.clearlinux.org/releases/15700/clear/config/image/``
67 |
68 | #. Download the “PostNonChroot” script (if applicable).
69 |
70 | The JSON configuration file for the image may have an accompanying
71 | “PostNonChroot” script that is executed at the end of the image creation
72 | process. If it does, download the script and make it executable.
73 |
74 | #. Edit the JSON configuration file as needed.
75 |
76 | #. If your configuration file has an accompanying "PostNonChroot" script, change
77 | the default path of the script to match your path.
78 |
79 | #. Generate the new image with the following command:
80 |
81 | .. code-block:: bash
82 |
83 | sudo ister.py -t [JSON configuration]
84 |
85 | Related topics
86 | **************
87 |
88 | * :ref:`mixer`
89 | * :ref:`bulk-provision`
90 |
91 | .. _ister.py: https://github.com/bryteise/ister
92 | .. _Current release: https://cdn.download.clearlinux.org/current/
93 | .. _Previous releases: https://cdn.download.clearlinux.org/releases/
94 |
--------------------------------------------------------------------------------
/source/guides/maintenance/resource-limits.rst:
--------------------------------------------------------------------------------
1 | .. _resource-limits:
2 |
3 | Resource limits
4 | ###############
5 |
6 | Linux systems employ limiting or quota mechanisms to provide quality of
7 | service for system resources and contain rogue processes.
8 |
9 | These limits are layered at the system-level and user-level. If these limits
10 | need to be modified, it is useful to understand the different limit
11 | configurations.
12 |
13 | .. contents:: :local:
14 | :depth: 2
15 |
16 |
17 | System-wide limits
18 | ==================
19 |
20 | Some global resource limits are implemented in the Linux kernel and are
21 | controllable with kernel parameters.
22 |
23 | For example, a global limit for the maximum number of open files is set with
24 | the *fs.file-max* parameter. This limit applies to all processes and users an
25 | cannot be exceeded other limit values.
26 |
27 | Checking limit
28 | **************
29 |
30 | You can check a current value with :command:`sysctl -n `. For
31 | example:
32 |
33 | .. code:: bash
34 |
35 | sysctl -n fs.file-max
36 |
37 |
38 | This *fs.file-max* value is set intentionally high on |CL| systems by
39 | default. You can check the maximum value supported by the system with:
40 |
41 | .. code::
42 |
43 | cat /proc/sys/fs/file-max
44 |
45 |
46 | Overriding limit
47 | ****************
48 |
49 | You can override a value with :command:`sysctl -w `. For
50 | example:
51 |
52 | .. code:: bash
53 |
54 | sudo sysctl -w fs.file-max=
55 |
56 | If needed permanently, the value can be set by creating a
57 | :file:`/etc/sysctl.d/*.conf` file (see :command:`man sysctl.d` for details).
58 | For example:
59 |
60 | .. code:: bash
61 |
62 | sudo mkdir -p /etc/sysctl.d/
63 |
64 | sudo tee /etc/sysctl.d/fs-file-max.conf > /dev/null <<'EOF'
65 | fs.file-max=
66 | EOF
67 |
68 |
69 |
70 |
71 |
72 | Per-user limits
73 | ===============
74 |
75 | For processes not managed by systemd, resource limits can be set for PAM
76 | logins on a per-user basis with upper and lower limits in the
77 | :file:`/etc/security/limits.conf` file.
78 |
79 | You can set temporary values and check the current values with the
80 | :command:`ulimit` command. For example, to change the soft limit of maximum
81 | number of open file descriptors for the current user:
82 |
83 | .. code::
84 |
85 | ulimit -S -n
86 |
87 | See :command:`man limits.conf` for details.
88 |
89 |
90 | Service limits
91 | ==============
92 |
93 | Resource limits for services started with systemd units do not follow normal
94 | user limits because the process is started in a seperate `Linux control group
95 | (cgroup) `_ Linux
96 | cgroups associate related process groups and provide resource accounting.
97 |
98 | Resource limits for individual systemd services can be controlled inside their
99 | unit files or its configuration drop-in directory with the resource Limit
100 | directives. See `process properties section of the systemd.exec man page
101 | `_.
102 |
103 | Resource limits for all systemd services can be controlled with a file in the
104 | :file:`/etc/systemd/system.conf.d/` directory. For example, to have no
105 | restriction on the number of open files:
106 |
107 | .. code::
108 |
109 | sudo mkdir -p /etc/systemd/system.conf.d/
110 |
111 | sudo tee /etc/systemd/system.conf.d/50-nfiles.conf > /dev/null <<'EOF'
112 | [Manager]
113 | DefaultLimitNOFILE=infinity
114 | EOF
115 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
--------------------------------------------------------------------------------
37 |
38 |