diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index bc5cd177..74496d0d 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -3,33 +3,33 @@ |CL-PRJ| ############################################# -Welcome to the |CLOSIA| documentation pages, the source for |CL| documentation. +Welcome to the |CL-ATTR| documentation pages, the source for |CL| documentation. Our documentation is divided into the following sections: * :ref:`get-started` - If you are new to |CL|, get started fast with tutorials for installing |CL| on - bare metal, in a virtual environment, or as a live image on a USB stick. + If you are new to |CL|, get started fast with tutorials for installing |CL| on + bare metal, in a virtual environment, or as a live image on a USB stick. -* :ref:`concepts` - - Wondering what makes |CL| different? Learn about |CL| features and what +* :ref:`concepts` + + Wondering what makes |CL| different? Learn about |CL| features and what differentiates |CL| from other Linux distros. -* :ref:`guides` +* :ref:`guides` - Guides show how to complete common tasks that help you leverage |CL| native - features effectively. From basic system configuration to advanced management + Guides show how to complete common tasks that help you leverage |CL| native + features effectively. From basic system configuration to advanced management of a cloud installation, there is a guide for you. -* :ref:`tutorials` +* :ref:`tutorials` - |CL| tutorials provide step-by-step instructions on how |CL| features can - be used and extended, frequently with third-party tools. + |CL| tutorials provide step-by-step instructions on how |CL| features can + be used and extended, frequently with third-party tools. -* :ref:`reference` - - Find the detailed information you need to enable your configuration or task +* :ref:`reference` + + Find the detailed information you need to enable your configuration or task in our |CL| reference section. .. toctree:: diff --git a/source/clear-linux/tutorials/aws-web/aws-web.rst b/source/clear-linux/tutorials/aws-web/aws-web.rst index 25b9b1af..1cf7b688 100644 --- a/source/clear-linux/tutorials/aws-web/aws-web.rst +++ b/source/clear-linux/tutorials/aws-web/aws-web.rst @@ -1,6 +1,6 @@ .. _aws-web: -Create and launch Clear Linux from Amazon Web Services +Create and launch |CL-ATTR| from Amazon Web Services ###################################################### This tutorial walks you through creating and launching a |CL| @@ -25,14 +25,14 @@ This tutorial assumes the following statements are true: directory. * You have already set up an AWS user account and logged into the AWS console. - + .. note:: This tutorial uses a |CL| AMI t2.micro instance that is eligible for the AWS free tier. To learn more about AWS and setting up an account, visit the AWS website at http://aws.amazon.com. -Locate, select, and launch the Clear Linux OS Basic AMI -******************************************************* +Locate, select, and launch the |CL| Basic AMI +********************************************* #. Start from your main AWS services console menu in your browser and select the :guilabel:`EC2` text as shown in figure 1: @@ -57,18 +57,18 @@ Locate, select, and launch the Clear Linux OS Basic AMI This selection takes you to the :guilabel:`Step 1: Choose an Amazon Machine Image (AMI)` menu. -#. To find the :guilabel:`|CL| OS Basic` AMI in the +#. To find the :guilabel:`Clear Linux OS Basic` AMI in the :guilabel:`Step 1: Choose an Amazon Machine Image (AMI)` menu, do the following: - + #. In the lefthand navigation window, select the :guilabel:`AWS Marketplace` menu item to bring up the search bar to :guilabel:`Search AWS Marketplace Products`. - #. In the search bar, type `clear linux os` and hit the :kbd:`Enter` key to - search for and locate the :guilabel:`|CL| OS Basic` AMI. + #. In the search bar, type "clear linux os" and hit the :kbd:`Enter` key to + search for and locate the :guilabel:`Clear Linux OS Basic` AMI. - #. Select the :guilabel:`|CL| OS Basic` AMI by clicking on the + #. Select the :guilabel:`Clear Linux OS Basic` AMI by clicking on the :guilabel:`Select` button as shown in figure 3: .. figure:: figures/aws-web-3.png @@ -78,7 +78,7 @@ Locate, select, and launch the Clear Linux OS Basic AMI Figure 3: :guilabel:`Step 1: Choose AMI` #. A pop-up dialog box appears showing you more information about the - :guilabel:`|CL| OS Basic` AMI along with the pricing details for running + :guilabel:`Clear Linux OS Basic` AMI along with the pricing details for running |CL| on different platform configurations as shown in figure 4. Select the :guilabel:`Continue` button. @@ -129,13 +129,13 @@ Locate, select, and launch the Clear Linux OS Basic AMI Figure 7: :guilabel:`Select an existing key pair or create a new pair` #. Select the :guilabel:`Create a new key pair` option. - + #. For the :guilabel:`Key pair name` field, enter `AWSClearTestKey`. - + #. Select the :guilabel:`Download Key Pair` button to download the :file:`AWSClearTestKey.pem` to your browser's defined :file:`Downloads` directory. - + #. When the file finishes downloading, select the :guilabel:`Launch Instances` button to proceed to the :guilabel:`Launch Status` menu shown in figure 8. @@ -171,8 +171,8 @@ other instances available, they are also listed but not selected. #. To connect to your running instance, click the :guilabel:`Connect` button located at the top of your dashboard. AWS brings up the pop-up dialog - box shown in figure 11 describing how to connect to your running instance. - + box shown in figure 11 describing how to connect to your running instance. + .. _fig-aws-web-11: .. figure:: figures/aws-web-11.png @@ -223,10 +223,10 @@ other instances available, they are also listed but not selected. .. code-block:: console Warning: Permanently added 'ec2-34-209-39-184.us-west-2.compute.amazonaws.com,34.209.39.184' (ECDSA) to the list of known hosts. - clear@clr-96a8565d0ca54b0c80364a1e5e7b0f88 ~ $ + clear@clr-96a8565d0ca54b0c80364a1e5e7b0f88 ~ $ -Update the Clear Linux OS instance -********************************** +Update the |CL| instance +************************ Run the :command:`sudo swupd update` command to update the operating system as shown in figure 12: @@ -239,8 +239,8 @@ system as shown in figure 12: In this example we updated from version 18940 to 19100. -Stop the Clear Linux OS instance -******************************** +Stop the |CL| instance +********************** When you are finished using your AWS |CL| instance you need to stop it using the :guilabel:`Instances` dashboard to stop accruing charges. Complete the diff --git a/source/clear-linux/tutorials/azure.rst b/source/clear-linux/tutorials/azure.rst index 397b7032..3d278f13 100644 --- a/source/clear-linux/tutorials/azure.rst +++ b/source/clear-linux/tutorials/azure.rst @@ -1,9 +1,9 @@ .. _azure: -Run Clear Linux using Microsoft Azure CLI 2.0 -############################################# +Run |CL-ATTR| using Microsoft Azure CLI 2.0 +########################################### -|CLOSIA| is available for you to use in the Microsoft* Azure* marketplace and +|CL-ATTR| is available for you to use in the Microsoft* Azure* marketplace and is offered with three different images, also known as a :abbr:`SKU (Stock Keeping Unit)`. @@ -89,8 +89,8 @@ sysadmin-basic software bundle using the :command:`swupd` command: instructions in the `MS Azure Install Azure CLI tutorial`_ for your specific operating system. -Install MS Azure CLI 2.0 on Clear Linux -*************************************** +Install MS Azure CLI 2.0 on |CL| +******************************** #. To install the MS Azure CLI 2.0 on |CL|, use the :command:`curl` command as follows: @@ -335,8 +335,8 @@ of resources within MS Azure. "tags": null } -Create and log into the Clear Linux virtual machine -*************************************************** +Create and log into the |CL| virtual machine +******************************************** For this tutorial, we are using the |CL| Basic SKU for our VM. @@ -467,8 +467,8 @@ For this tutorial, we are using the |CL| Basic SKU for our VM. When you are finished using your new |CL| VM, type :command:`exit` to close the :command:`SSH` terminal and logout. -Stop and deallocate the Clear Linux VM and resources -**************************************************** +Stop and deallocate the |CL| VM and resources +********************************************* When you finish using your new |CL| instance, you must stop the VM and deallocate the resources in your resource group. If you only stop a VM, the OS @@ -516,7 +516,7 @@ Next steps To see use cases you can fulfill with your |CL| instance, visit our :ref:`tutorials ` section. -For additional information visit the Clear Linux +For additional information visit the |CL| `Azure Partner Mini Case Study`_ and the `Azure Partner Datasheet`_. To learn more about the MS Azure CLI 2.0 tool and options that are available, diff --git a/source/clear-linux/tutorials/docker/docker.rst b/source/clear-linux/tutorials/docker/docker.rst index f6a0d0c3..284850e2 100644 --- a/source/clear-linux/tutorials/docker/docker.rst +++ b/source/clear-linux/tutorials/docker/docker.rst @@ -87,7 +87,7 @@ of containers by using a hardware-backed virtual machine container runtime rather than software namespace containers that are provided by the standard Docker *runc* runtime. -Clear Linux provides easy integration of the *kata-runtime* with Docker. +|CL| provides easy integration of the *kata-runtime* with Docker. More information on installing and using the *kata-runtime* may be found at :ref:`kata`. diff --git a/source/clear-linux/tutorials/fmv.rst b/source/clear-linux/tutorials/fmv.rst index ea6699ed..31dcdeaf 100644 --- a/source/clear-linux/tutorials/fmv.rst +++ b/source/clear-linux/tutorials/fmv.rst @@ -18,8 +18,8 @@ In this tutorial we will use FMV on general code and on tutorial, you will be able to use this technology on your code and use the libraries to deploy architecture-based optimizations to your application code. -Install and configure a Clear Linux host on bare metal -****************************************************** +Install and configure a |CL| host on bare metal +*********************************************** First, follow our guide to :ref:`bare-metal-install`. @@ -184,7 +184,7 @@ You can see the multiple clones of the `foo` function: The cloned functions use AVX2 registers and vectorized instructions. To verify, enter the following commands: -:: +:: vpaddd (%r8,%rax,1),%ymm0,%ymm0 vmovdqu %ymm0,(%rcx,%rax,1) @@ -219,16 +219,16 @@ generates the following patches: --- fftw-3.3.6-pl2/libbench2/verify-lib.c 2017-01-27 21:08:13.000000000 +0000 +++ fftw-3.3.6-pl2/libbench2/verify-lib.c~ 2017-09-27 17:49:21.913802006 +0000 @@ -33,6 +33,7 @@ - + double dmax(double x, double y) { return (x > y) ? x : y; } - + +__attribute__((target_clones("avx2","arch=atom","default"))) static double aerror(C *a, C *b, int n) { if (n > 0) { @@ -111,6 +112,7 @@ } - + /* make array hermitian */ +__attribute__((target_clones("avx2","arch=atom","default"))) void mkhermitian(C *A, int rank, const bench_iodim *dim, int stride) @@ -236,7 +236,7 @@ generates the following patches: if (rank == 0) @@ -148,6 +150,7 @@ } - + /* C = A + B */ +__attribute__((target_clones("avx2","arch=atom","default"))) void aadd(C *c, C *a, C *b, int n) @@ -244,7 +244,7 @@ generates the following patches: int i; @@ -159,6 +162,7 @@ } - + /* C = A - B */ +__attribute__((target_clones("avx2","arch=atom","default"))) void asub(C *c, C *a, C *b, int n) @@ -252,7 +252,7 @@ generates the following patches: int i; @@ -170,6 +174,7 @@ } - + /* B = rotate left A (complex) */ +__attribute__((target_clones("avx2","arch=atom","default"))) void arol(C *b, C *a, int n, int nb, int na) @@ -267,8 +267,8 @@ bringing architecture-based optimizations to application code even easier. **Congratulations!** -You have successfully installed an FMV development environment on Clear -Linux. Furthermore, you used cutting edge compiler technology to improve the +You have successfully installed an FMV development environment on |CL|. +Furthermore, you used cutting edge compiler technology to improve the performance of your application based on Intel Architecture technology and profiling of the specific execution of your application. diff --git a/source/clear-linux/tutorials/greengrass.rst b/source/clear-linux/tutorials/greengrass.rst index 86120285..9ffb7239 100644 --- a/source/clear-linux/tutorials/greengrass.rst +++ b/source/clear-linux/tutorials/greengrass.rst @@ -21,7 +21,7 @@ This tutorial shows how to: Supported Platforms ******************* -* Operating System: |CL-ATTR| latest release +* Operating System: |CL| latest release * Hardware: Intel® core platforms (Tutorial supports inference on CPU only) Description of Samples @@ -188,6 +188,19 @@ Creating and Packaging Lambda Functions ======================================= #. Complete the tutorial at `Configure AWS Greengrass on AWS IoT`_ . +<<<<<<< HEAD + + .. note:: + + This creates the tarball needed to create the AWS Greengrass + environment on the edge device. + +#. Assure to download both the security resources and the AWS Greengrass + core software. + + .. note:: + +======= .. note:: diff --git a/source/clear-linux/tutorials/hadoop.rst b/source/clear-linux/tutorials/hadoop.rst index a489c855..63d6d110 100644 --- a/source/clear-linux/tutorials/hadoop.rst +++ b/source/clear-linux/tutorials/hadoop.rst @@ -4,7 +4,7 @@ Set up a single node cluster with Hadoop\* ########################################## This tutorial walks you through the process of installing, configuring, and -running Apache\* Hadoop on |CLOSIA|. The Apache Hadoop software library is a +running Apache\* Hadoop on |CL-ATTR|. The Apache Hadoop software library is a framework for distributed processing of large data sets across clusters of computers using simple programming models. It is designed to scale up from single servers to thousands of machines, with each machine offering local @@ -14,7 +14,7 @@ Prerequisites ************* Before following this tutorial, you should follow the -:ref:`bare-metal-install` to ensure you have installed |CLOSIA|. +:ref:`bare-metal-install` to ensure you have installed |CL|. Before you install any new packages, update |CL| with the following command: diff --git a/source/clear-linux/tutorials/kata.rst b/source/clear-linux/tutorials/kata.rst index aee38778..4dbdb3bb 100644 --- a/source/clear-linux/tutorials/kata.rst +++ b/source/clear-linux/tutorials/kata.rst @@ -4,7 +4,7 @@ Install Kata Containers\* ######################### This tutorial describes how to install, configure, and run `Kata Containers`_ -on |CLOSIA|. Kata Containers is an open source project developing a +on |CL-ATTR|. Kata Containers is an open source project developing a lightweight implementation of :abbr:`VMs (Virtual Machines)` that offer the speed of containers and the security of VMs. @@ -79,12 +79,12 @@ Run Kata Containers **Congratulations!** -You've successfully installed and set up Kata Containers on |CLOSIA|. +You've successfully installed and set up Kata Containers on |CL|. More information about Docker ***************************** -Docker on |CLOSIA| provides a :file:`docker.service` file to start the Docker +Docker on |CL| provides a :file:`docker.service` file to start the Docker daemon. The daemon will use runc or kata-runtime depending on the environment: diff --git a/source/clear-linux/tutorials/kata_migration.rst b/source/clear-linux/tutorials/kata_migration.rst index 942d799c..41440a1b 100644 --- a/source/clear-linux/tutorials/kata_migration.rst +++ b/source/clear-linux/tutorials/kata_migration.rst @@ -6,7 +6,7 @@ Migrate Clear Containers to Kata Containers\* `Clear Containers`_ and `Kata Containers`_ can co-exist in the same system. Both can be installed through the :file:`containers-virt bundle`. However, we recommend that you migrate to Kata Containers because Clear Containers is no -longer maintained_ and will soon be deprecated on |CLOSIA|. +longer maintained_ and will soon be deprecated on |CL-ATTR|. This guide describes how to migrate to Kata Containers and assumes that: @@ -68,7 +68,7 @@ Enable Kata Containers as default Run Kata Containers ******************* -Use the following command: +Use the following command: .. code-block:: bash diff --git a/source/clear-linux/tutorials/kubernetes.rst b/source/clear-linux/tutorials/kubernetes.rst index b5761750..794e92e6 100644 --- a/source/clear-linux/tutorials/kubernetes.rst +++ b/source/clear-linux/tutorials/kubernetes.rst @@ -3,7 +3,7 @@ Run Kubernetes\* on |CL-ATTR| ############################# -This tutorial describes how to install, configure, and run the +This tutorial describes how to install, configure, and run the `Kubernetes container orchestration system`_ on |CL-ATTR| using different container engines and runtimes. @@ -17,7 +17,7 @@ strong isolation for untrusted workloads or multi-tenant scenarios. Runc and Kata Containers can be allocated on a per-pod basis so you can mix and match both on the same host to suit your needs. -This tutorial describes the following combinations: +This tutorial describes the following combinations: * Kubernetes with Docker and runc * Kubernetes with CRI-O and kata-runtime @@ -26,7 +26,7 @@ Prerequisites ************* This tutorial assumes you have installed |CL| and updated to the latest -release on your host system. You can learn about the benefits of having an +release on your host system. You can learn about the benefits of having an up-to-date system for cloud orchestration on the :ref:`swupd-about` page. For detailed instructions on installing |CL| on a bare metal system, follow the :ref:`bare metal installation tutorial`. @@ -40,8 +40,8 @@ Before you install any new packages, update |CL| with the following command: Install Kubernetes and CRI runtimes *********************************** -Kubernetes and a set of supported :abbr:`CRI (Container Runtime Interface)` -runtimes are included in the `cloud-native-basic`_ bundle. To install the +Kubernetes and a set of supported :abbr:`CRI (Container Runtime Interface)` +runtimes are included in the `cloud-native-basic`_ bundle. To install the framework, enter the following command: .. code-block:: bash @@ -276,7 +276,7 @@ with the displayed token and IP information. Related topics ************** -Read the Kubernetes documentation to learn more about: +Read the Kubernetes documentation to learn more about: * `Understanding basic Kubernetes architecture`_ @@ -308,7 +308,7 @@ following commands: sudo cp /usr/share/defaults/crio/crio.conf /etc/crio/ sudo $EDITOR /etc/crio/crio.conf -Learn more about `Stateless in Clear Linux`_ and view the `Clear Linux documentation`_. +Learn more about `Stateless`_ in |CL| and view the |CL| `documentation`_. Proxy configuration (optional) ****************************** @@ -343,7 +343,7 @@ Troubleshooting Your DNS server may not be appropriately configured. Try adding an entry to the :file:`/etc/hosts` file with your host's IP and Name. - + For example: 100.200.50.20 myhost Use the commands :command:`hostname` and :command:`hostname -I` to retrieve them. @@ -408,7 +408,7 @@ Troubleshooting .. _Joining your nodes: https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/#join-nodes -.. _Stateless in Clear Linux: https://clearlinux.org/features/stateless +.. _Stateless: https://clearlinux.org/features/stateless -.. _Clear Linux documentation: https://clearlinux.org/documentation/clear-linux +.. _documentation: https://clearlinux.org/documentation/clear-linux diff --git a/source/clear-linux/tutorials/machine-learning/machine-learning.rst b/source/clear-linux/tutorials/machine-learning/machine-learning.rst index e16a25f0..2b9da141 100644 --- a/source/clear-linux/tutorials/machine-learning/machine-learning.rst +++ b/source/clear-linux/tutorials/machine-learning/machine-learning.rst @@ -3,18 +3,18 @@ TensorFlow\* machine learning on |CL-ATTR| ########################################## -This tutorial will demonstrate the installation and execusion of a TensorFlow\* +This tutorial will demonstrate the installation and execusion of a TensorFlow\* machine learning example on |CL-ATTR|. It uses a Jupyter\* Notebook and MNIST data for handwriting recognition.  -The initial steps will have you set up a Jupyter kernel and run a Notebook +The initial steps will have you set up a Jupyter kernel and run a Notebook on a bare-metal |CL| system. Prerequisites ************* -This tutorial assumes you have installed |CL| on your host system. For detailed -instructions on installing |CL| on a bare metal system, follow the +This tutorial assumes you have installed |CL| on your host system. For detailed +instructions on installing |CL| on a bare metal system, follow the :ref:`bare metal installation tutorial`. Before you install any new packages, update |CL| with the following command: @@ -191,7 +191,7 @@ run the example code. Figure 8: The system's accuracy for the entire data set. -For more in-depth information on the model used and the mathematics it entails, +For more in-depth information on the model used and the mathematics it entails, visit the TensorFlow tutorials `TensorFlow MNIST beginners demo`_ and `TensorFlow MNIST pros demo`_. diff --git a/source/clear-linux/tutorials/multi-boot/multi-boot-restore-bl.rst b/source/clear-linux/tutorials/multi-boot/multi-boot-restore-bl.rst index 88e307db..2b71ffd5 100644 --- a/source/clear-linux/tutorials/multi-boot/multi-boot-restore-bl.rst +++ b/source/clear-linux/tutorials/multi-boot/multi-boot-restore-bl.rst @@ -1,6 +1,6 @@ .. _multi-boot-restore-bl: -Restore the Clear Linux boot loader +Restore the |CL-ATTR| boot loader ################################### This guide is part of the :ref:`multi-boot` tutorial. If you install a new diff --git a/source/clear-linux/tutorials/multi-boot/multi-boot.rst b/source/clear-linux/tutorials/multi-boot/multi-boot.rst index 57e0af9e..778729d0 100644 --- a/source/clear-linux/tutorials/multi-boot/multi-boot.rst +++ b/source/clear-linux/tutorials/multi-boot/multi-boot.rst @@ -1,9 +1,9 @@ .. _multi-boot: -Multi-boot Clear Linux with other operating systems -################################################### +Multi-boot |CL-ATTR| with other operating systems +################################################# -|CLOSIA| uses the Systemd-Boot boot loader, which does not support multi- +|CL-ATTR| uses the Systemd-Boot boot loader, which does not support multi- booting without manual manipulation. This tutorial shows how to configure the |CL| boot loader to work with other :abbr:`OSes (operating systems)`. @@ -99,8 +99,8 @@ Detailed procedures .. _multi-boot-cl: -Install Clear Linux OS -********************** +Install |CL| +************ Navigation tips for text-based installation interfaces: diff --git a/source/clear-linux/tutorials/smb/smb.rst b/source/clear-linux/tutorials/smb/smb.rst index 2fb02220..71e9baee 100644 --- a/source/clear-linux/tutorials/smb/smb.rst +++ b/source/clear-linux/tutorials/smb/smb.rst @@ -4,7 +4,7 @@ Enable simple file sharing with a Windows\* machine using Samba\* ################################################################# This tutorial describes how to enable simple file sharing from a system -running |CLOSIA| to a Windows machine using Samba. For more advanced sharing, +running |CL-ATTR| to a Windows machine using Samba. For more advanced sharing, refer to the `Samba guide`_. Prerequisites @@ -96,8 +96,8 @@ use the hostname of the |CL| machine. For other ways to access shares using a hostname instead of an IP address, see `Chapter 7 of the Samba guide`_. -Map Clear Linux drive in Windows -******************************** +Map |CL| drive in Windows +************************* #. Open Windows Explorer and click on the left sidebar on :guilabel:`This PC` to change the options available at the top. diff --git a/source/clear-linux/tutorials/spark.rst b/source/clear-linux/tutorials/spark.rst index 5b02cb9a..d1b0957e 100644 --- a/source/clear-linux/tutorials/spark.rst +++ b/source/clear-linux/tutorials/spark.rst @@ -4,7 +4,7 @@ Set up a standalone cluster system using Apache\* Spark\* ######################################################### This tutorial describes how to install, configure, and run Apache Spark on -|CLOSIA|. Apache Spark is a fast general-purpose cluster computing system with +|CL-ATTR|. Apache Spark is a fast general-purpose cluster computing system with the following features: * Provides high-level APIs in Java\*, Scala\*, Python\*, and R\*. diff --git a/source/clear-linux/tutorials/telemetry-backend/telemetry-backend.rst b/source/clear-linux/tutorials/telemetry-backend/telemetry-backend.rst index 131471c3..40ce9c58 100644 --- a/source/clear-linux/tutorials/telemetry-backend/telemetry-backend.rst +++ b/source/clear-linux/tutorials/telemetry-backend/telemetry-backend.rst @@ -1,9 +1,9 @@ .. _telemetry-backend: -Create a telemetry backend server in Clear Linux -################################################ +Create a telemetry backend server in |CL-ATTR| +############################################## -|CLOSIA| includes a telemetry and analytics solution, also known as +|CL-ATTR| includes a telemetry and analytics solution, also known as telemetrics, as part of the OS that records events of interest and reports them back to the development team using the telemetrics daemons that are running on the |CL| client system. @@ -23,14 +23,13 @@ A telemetry backend server consists of two Flask applications: The applications run within a web stack, using the :guilabel:`nginx` web server, the :guilabel:`uWSGI` application server, and :guilabel:`PostgreSQL` as the underlying database server. For a detailed -description, visit the `Clear Linux telemetry backend server overview`_. +description, visit the |CL| `telemetrics backend`_ server overview. This tutorial walks you through creating a telemetrics backend server on your local |CL| machine. The tutorial uses the :command:`deploy.sh` bash -shell script that is maintained in a GitHub repository at -https://github.com/clearlinux/telemetrics-backend. Once the backend server is -up and running, we show you how to redirect telemetry records from the system -you set up to this new server location. +shell script that is maintained in a the `telemetrics backend`_ GitHub repository. +Once the backend server isup and running, we show you how to redirect telemetry +records from the system you set up to this new server location. .. note:: The telemetrics functionality adheres to `Intel privacy policies`_ @@ -82,7 +81,7 @@ Run the deploy.sh script to install the backend server cd telemetrics-backend/scripts ./deploy.sh -h - + Deploy snapshot of the telemetrics-backend -a Perform specified action (deploy, install, migrate, resetdb, @@ -111,8 +110,8 @@ following actions: * *uninstall* - uninstall all packages. .. note:: - - The *uninstall* option does not perform any actions if the + + The *uninstall* option does not perform any actions if the distro is set to |CL| and will only uninstall packages if the distro is Ubuntu @@ -160,7 +159,7 @@ To begin the installation with the options defined: #. For the :guilabel:`DB password:`, press the :kbd:`Enter` key to accept the default password `postgres`. - + The :command:`swupd` begins installing the required software bundles to set up the telemetrics backend server. The output will look similar to what is shown below: @@ -234,7 +233,7 @@ the requirements to install and implement the telemetrics server. Finally, the script enables the server and provides output similar to: .. code-block:: console - + Collecting uwsgitop Downloading uwsgitop-0.10.tar.gz Requirement already satisfied: simplejson in /usr/lib/python3.6/site-packages (from uwsgitop) @@ -331,7 +330,7 @@ Once all the server components have been installed you are prompted to enter the :guilabel:`PostgreSQL` database password to change it as illustrated below: .. code-block:: console - + Enter password for 'postgres' user: New password: Retype new password: @@ -344,7 +343,7 @@ database password will be updated. The script finalizes installation and finishes. .. code-block:: console - + Created symlink /etc/systemd/system/multi-user.target.wants/postgresql.service → /usr/lib/systemd/system/postgresql.service. Cloning into 'telemetrics-backend'... remote: Counting objects: 344, done. @@ -461,8 +460,8 @@ server, redirected the records from your local machine to this new server and tested it using the :command:`hprobe` command to send a ``hello`` record to it. -Additional resources -******************** +Related topics +************** * `Telemetry feature description`_ * :ref:`Telemetry architecture` @@ -470,7 +469,7 @@ Additional resources * https://github.com/clearlinux/telemetrics-client * https://github.com/clearlinux/telemetrics-backend -.. _`Clear Linux telemetry backend server overview`: +.. _`telemetrics backend`: https://github.com/clearlinux/telemetrics-backend .. _`Intel privacy policies`: diff --git a/source/clear-linux/tutorials/wordpress/web-server-install.rst b/source/clear-linux/tutorials/wordpress/web-server-install.rst index b4c5fb93..e9788ef3 100644 --- a/source/clear-linux/tutorials/wordpress/web-server-install.rst +++ b/source/clear-linux/tutorials/wordpress/web-server-install.rst @@ -3,14 +3,15 @@ Set up a LAMP web server on |CL-ATTR| ##################################### -This tutorial provides instructions on how to set up a -:abbr:`LAMP (Linux, Apache, MySQL, PHP)` web server on |CL-ATTR| and how -to use phpMyAdmin\* to manage an associated database. Note that this +This tutorial provides instructions on how to set up a +:abbr:`LAMP (Linux, Apache, MySQL, PHP)` web server on |CL-ATTR| and how +to use phpMyAdmin\* to manage an associated database. Note that this tutorial installs MariaDB\*, which is a drop-in replacement for MySQL\*. -In order to create a web server using |CL| as the host OS, your host system -must be running |CL|. This tutorial assumes you have successfully installed -:ref:`Clear Linux on bare metal`. +In order to create a web server using |CL| as the host OS, your host system +must be running |CL|. This tutorial assumes you have installed |CL| on your +host system. For detailed instructions on installing |CL| on a bare metal system, +visit the :ref:`bare metal installation tutorial`. This tutorial covers: @@ -20,19 +21,19 @@ This tutorial covers: Install Apache ************** -Apache is an open source HTTP web server application that can run on several -operating systems, including |CL|. Go to the `Apache HTTP Server Project`_ +Apache is an open source HTTP web server application that can run on several +operating systems, including |CL|. Go to the `Apache HTTP Server Project`_ for more information. Install the web-server-basic bundle =================================== -The **web-server-basic** bundle contains the packages needed to install the +The **web-server-basic** bundle contains the packages needed to install the Apache software bundle on |CL|. .. note:: - Before you install new packages, update the |CL| with the following + Before you install new packages, update the |CL| with the following console command: .. code-block:: bash @@ -56,7 +57,7 @@ Apache software bundle on |CL|. #. To verify that the Apache server application is running, open a web browser and navigate to: http://localhost. - If the service is running, a confirmation message will appear, similar to the + If the service is running, a confirmation message will appear, similar to the message shown in figure 1. .. figure:: figures/web-server-install-1.png @@ -67,19 +68,19 @@ Apache software bundle on |CL|. .. note:: - The :file:`index.html` file is located in the :file:`/var/www/html` directory - of your host system. You will copy this file into a new location after you + The :file:`index.html` file is located in the :file:`/var/www/html` directory + of your host system. You will copy this file into a new location after you modify the configuration in the next step. Change the default configuration and data directory *************************************************** -|CL| is designed to be a `stateless`_ operating system which means that you -must create an optional configuration file to override the default values. -The default location of the Apache configuration file, :file:`httpd.conf`, -is located in the :file:`/usr/share/defaults/httpd` directory. |CL| can -override this directory as part of the stateless paradigm. This default -:file:`.conf` file includes the following directives that allow for additional +|CL| is designed to be a `stateless`_ operating system which means that you +must create an optional configuration file to override the default values. +The default location of the Apache configuration file, :file:`httpd.conf`, +is located in the :file:`/usr/share/defaults/httpd` directory. |CL| can +override this directory as part of the stateless paradigm. This default +:file:`.conf` file includes the following directives that allow for additional locations of configuration definitions: .. code-block:: console @@ -90,23 +91,23 @@ locations of configuration definitions: IncludeOptional /etc/httpd/conf.d/*.conf IncludeOptional /etc/httpd/conf.modules.d/*.conf -In this section you will define your own httpd.conf file to override the +In this section you will define your own httpd.conf file to override the default values, and define a custom DocumentRoot for your web server. -#. Create the directory structure for :file:`/etc/httpd/conf.d`. +#. Create the directory structure for :file:`/etc/httpd/conf.d`. .. code-block:: bash sudo mkdir -p /etc/httpd/conf.d -#. Create and open the :file:`httpd.conf` file in your new :file:`/etc/httpd/conf.d` +#. Create and open the :file:`httpd.conf` file in your new :file:`/etc/httpd/conf.d` directory. .. code-block:: bash sudo nano /etc/httpd/conf.d/httpd.conf -#. Add the ``DocumentRoot`` variable to :file:`httpd.conf`. Copy the content +#. Add the ``DocumentRoot`` variable to :file:`httpd.conf`. Copy the content listed below into the new :file:`/etc/httpd/conf.d/httpd.conf` file. .. code-block:: console @@ -124,8 +125,8 @@ default values, and define a custom DocumentRoot for your web server. Require all granted -#. Create a new ``DocumentRoot`` directory structure and copy the - :file:`index.html` file from :file:`/var/www/html` directory to +#. Create a new ``DocumentRoot`` directory structure and copy the + :file:`index.html` file from :file:`/var/www/html` directory to :file:`/var/www/tutorial`. .. code-block:: bash @@ -134,21 +135,21 @@ default values, and define a custom DocumentRoot for your web server. cd /var/www/tutorial sudo cp /var/www/html/index.html . -#. To ensure a successful setup, edit the new :file:`index.html` file with an - obvious change. +#. To ensure a successful setup, edit the new :file:`index.html` file with an + obvious change. .. code-block:: bash sudo nano index.html - For example, we changed the default message + For example, we changed the default message - "It works!" + "It works!" - to + to "It works from its new location!" - + #. Stop and then restart ``httpd.service``. .. code-block:: bash @@ -156,11 +157,11 @@ default values, and define a custom DocumentRoot for your web server. sudo systemctl stop httpd.service sudo systemctl start httpd.service -#. Go to http://localhost to view the new screen. You should see your updated +#. Go to http://localhost to view the new screen. You should see your updated default message from step 5. -#. Change the configuration back to the default :file:`/var/www/html` - location. To do this, edit the :file:`/etc/httpd/conf.d/httpd.conf` file +#. Change the configuration back to the default :file:`/var/www/html` + location. To do this, edit the :file:`/etc/httpd/conf.d/httpd.conf` file again and replace any instance of /var/www/tutorial with /var/www/html. .. code-block:: bash @@ -187,8 +188,8 @@ default values, and define a custom DocumentRoot for your web server. Install PHP *********** -An Apache installation allows you to display static web pages. Enabling PHP -allows you to generate and display dynamic web pages. To add this +An Apache installation allows you to display static web pages. Enabling PHP +allows you to generate and display dynamic web pages. To add this functionality to your web server, install PHP on your system. #. To get the php components, enter the following command: @@ -207,7 +208,7 @@ functionality to your web server, install PHP on your system. After restarting the Apache service, test your PHP installation. -#. Create and open a file named :file:`phpinfo.php` in the :file:`/var/www/html/` +#. Create and open a file named :file:`phpinfo.php` in the :file:`/var/www/html/` directory using a text editor. .. code-block:: bash @@ -230,14 +231,14 @@ functionality to your web server, install PHP on your system. `Figure 2: The PHP information screen.` -If the PHP information screen is displayed, you have successfully installed -the PHP components and are now ready to add your database application to +If the PHP information screen is displayed, you have successfully installed +the PHP components and are now ready to add your database application to complete your LAMP server implementation. Install MariaDB *************** -Install MariaDB to store content. MariaDB is a drop-in replacement for MySQL +Install MariaDB to store content. MariaDB is a drop-in replacement for MySQL and is available in the database-basic |CL| bundle. #. To install the database-basic bundle, enter the following command: @@ -259,12 +260,12 @@ and is available in the database-basic |CL| bundle. sudo systemctl status mariadb - Press :kbd:`Ctrl` + :kbd:`c` or :kbd:`q` to exit. + Press :kbd:`Ctrl` + :kbd:`c` or :kbd:`q` to exit. Security hardening ================== -With the MariaDB service running, we can perform some basic security +With the MariaDB service running, we can perform some basic security hardening. #. To add a basic layer of security, enter the following command: @@ -273,9 +274,9 @@ hardening. sudo mysql_secure_installation -#. Respond to the questions that appear in the script below. - - .. note:: +#. Respond to the questions that appear in the script below. + + .. note:: Our suggested responses follow each question. @@ -283,8 +284,8 @@ hardening. Enter current password for root (enter for none): - In order to secure MariaDB, we need the current password for the root - user. For a newly installed MariaDB without a set root password, the + In order to secure MariaDB, we need the current password for the root + user. For a newly installed MariaDB without a set root password, the password is blank. Thus, press enter to continue. .. code-block:: bash @@ -295,7 +296,7 @@ hardening. .. _set-password: - Set the root password to prevent unauthorized MariaDB root user logins. + Set the root password to prevent unauthorized MariaDB root user logins. To set a root password, type 'y'. .. code-block:: bash @@ -319,8 +320,8 @@ hardening. Remove anonymous users? [Y/n] By default, a MariaDB installation includes an anonymous user that allows - anyone to log in to MariaDB without a user account. This anonymous user - is intended only for testing and for a smoother installation. To remove + anyone to log in to MariaDB without a user account. This anonymous user + is intended only for testing and for a smoother installation. To remove the anonymous user and make your database more secure, type 'y'. .. code-block:: bash @@ -328,8 +329,8 @@ hardening. ... Success! Disallow root login remotely? [Y/n] - Normally, root should only be allowed to connect from the 'localhost'. This - ensures that someone cannot guess the root password from the network. To + Normally, root should only be allowed to connect from the 'localhost'. This + ensures that someone cannot guess the root password from the network. To block any remote root login, type 'y'. .. code-block:: bash @@ -337,8 +338,8 @@ hardening. ... Success! Remove test database and access to it? [Y/n] - By default, MariaDB includes a database named 'test' which anyone can access. - This database is also intended only for testing and should be removed. To + By default, MariaDB includes a database named 'test' which anyone can access. + This database is also intended only for testing and should be removed. To remove the test database, type 'y'. .. code-block:: bash @@ -349,7 +350,7 @@ hardening. ... Success! Reload privilege tables now? [Y/n] - Reloading the privilege tables ensures all changes made so far take + Reloading the privilege tables ensures all changes made so far take effect immediately. To reload the privilege tables, type 'y'. .. code-block:: bash @@ -363,15 +364,15 @@ hardening. Thanks for using MariaDB! -The MariaDB installation is complete, and we can now install phpMyAdmin to +The MariaDB installation is complete, and we can now install phpMyAdmin to manage the databases. Install phpMyAdmin ****************** -The web-based tool phpMyAdmin is a straightforward way to manage MySQL or -MariaDB databases. Visit the `phpMyAdmin`_ website for the complete -discussion regarding phpMyAdmin, its documentation, the latest downloads, +The web-based tool phpMyAdmin is a straightforward way to manage MySQL or +MariaDB databases. Visit the `phpMyAdmin`_ website for the complete +discussion regarding phpMyAdmin, its documentation, the latest downloads, and other useful information. In this tutorial, we use the latest English version of phpMyAdmin. @@ -404,14 +405,14 @@ In this tutorial, we use the latest English version of phpMyAdmin. Use phpMyAdmin to manage a database *********************************** -You can use the phpMyAdmin web-based tool to manage your databases. Follow the +You can use the phpMyAdmin web-based tool to manage your databases. Follow the steps below for setting up a database called "WordPress". #. Verify that a successful installation of all LAMP server components by going to http://localhost/phpMyAdmin. See figure 3. #. Log in with your root userid and the password you set up when you ran the - :ref:`mysql_secure_installation command `. Enter your + :ref:`mysql_secure_installation command `. Enter your credentials and select :guilabel:`Go` to log in: .. figure:: figures/web-server-install-3.png @@ -457,8 +458,8 @@ steps below for setting up a database called "WordPress". `Figure 6: The Privileges tab.` -#. Click :guilabel:`Add user account` located at the bottom of the - :guilabel:`Privileges` tab. The `Add user account` page appears, as shown +#. Click :guilabel:`Add user account` located at the bottom of the + :guilabel:`Privileges` tab. The `Add user account` page appears, as shown in figure 7. .. figure:: figures/web-server-install-7.png @@ -476,7 +477,7 @@ steps below for setting up a database called "WordPress". * Re-type: wp-example -#. In the `Database for user account` section, select +#. In the `Database for user account` section, select :guilabel:`Grant all privileges on database “WordPress”.` #. At the bottom of the page, click :guilabel:`Go`. @@ -491,7 +492,7 @@ If successful, you should see the screen shown in figure 8: **Congratulations!** -You have now created a fully functional LAMP server along with a +You have now created a fully functional LAMP server along with a WordPress\*-ready database using |CL|. Next steps diff --git a/source/clear-linux/tutorials/wordpress/wordpress.rst b/source/clear-linux/tutorials/wordpress/wordpress.rst index 31060894..6eecac79 100644 --- a/source/clear-linux/tutorials/wordpress/wordpress.rst +++ b/source/clear-linux/tutorials/wordpress/wordpress.rst @@ -1,22 +1,22 @@ .. _wordpress: -WordPress\* on |CL-ATTR| +WordPress\* on |CL-ATTR| ######################## -This tutorial describes how to setup a web server to host a WordPress\* site on a -|CL-ATTR| system. The tutorial is split into two sections: +This tutorial describes how to setup a web server to host a WordPress\* site on a +|CL-ATTR| system. The tutorial is split into two sections: #. :ref:`web-server-install` #. :ref:`wp-install` -If you already have a |CL| based :abbr:`LAMP (Linux, Apache, MySQL, PHP)` web server, +If you already have a |CL| based :abbr:`LAMP (Linux, Apache, MySQL, PHP)` web server, you can skip ahead to the second section of this tutorial. .. note:: - This tutorial is for development and testing purposes only. Additional steps - are required to secure production systems. Those steps are beyond the scope + This tutorial is for development and testing purposes only. Additional steps + are required to secure production systems. Those steps are beyond the scope of this tutorial. .. toctree:: diff --git a/source/clear-linux/tutorials/wordpress/wp-install.rst b/source/clear-linux/tutorials/wordpress/wp-install.rst index aa062e3e..8b4375e3 100644 --- a/source/clear-linux/tutorials/wordpress/wp-install.rst +++ b/source/clear-linux/tutorials/wordpress/wp-install.rst @@ -3,34 +3,34 @@ Set up WordPress\* on a LAMP web server ####################################### -This tutorial shows you how to install the WordPress\* components on your |CL| -:abbr:`LAMP (Linux, Apache, MySQL, PHP)` server. At the end of -:ref:`web-server-install`, you created a WordPress-ready database using -phpMyAdmin\* and MariaDB\*. Now that the LAMP server is up and running, you +This tutorial shows you how to install the WordPress\* components on your |CL| +:abbr:`LAMP (Linux, Apache, MySQL, PHP)` server. At the end of +:ref:`web-server-install`, you created a WordPress-ready database using +phpMyAdmin\* and MariaDB\*. Now that the LAMP server is up and running, you can add the WordPress components needed to host a WordPress website on your system. Before you begin **************** -This tutorial assumes you have successfully completed :ref:`bare-metal-install` +This tutorial assumes you have successfully completed :ref:`bare-metal-install` and that you have :ref:`web-server-install`. Create a WordPress server ************************* -WordPress can be installed in a variety of ways. These instructions are -written for users who have followed our instructions for installing phpMyAdmin -when they :ref:`set up a LAMP web server `. Note that -all steps in this tutorial have been tested using a NUC6i5SYH Intel® NUC. +WordPress can be installed in a variety of ways. These instructions are +written for users who have followed our instructions for installing phpMyAdmin +when they :ref:`set up a LAMP web server `. Note that +all steps in this tutorial have been tested using a NUC6i5SYH Intel® NUC. Visit the `NUC6i5SYH product page`_ for detailed information. -Numerous online articles are available to help you name your website and +Numerous online articles are available to help you name your website and acquire the necessary certificates. Those tasks are beyond the scope of this tutorial. -You can take several actions to harden your website from attacks. The security -of your website and the data it contains are complex and ever-evolving tasks. -Prioritize security if you plan to expose your website to the outside world. -This tutorial does not address security measures that you can take to harden +You can take several actions to harden your website from attacks. The security +of your website and the data it contains are complex and ever-evolving tasks. +Prioritize security if you plan to expose your website to the outside world. +This tutorial does not address security measures that you can take to harden your site but we strongly encourage you to take action. .. note:: @@ -41,10 +41,10 @@ your site but we strongly encourage you to take action. Download WordPress and manage directories ========================================= -For this tutorial, you will create a WordPress blog that can be accessed at: +For this tutorial, you will create a WordPress blog that can be accessed at: http:///blog. -To accomplish this setup, you must add WordPress components to the :file:`/var/www/html/blog` +To accomplish this setup, you must add WordPress components to the :file:`/var/www/html/blog` directory. Follow these steps: @@ -83,11 +83,11 @@ Follow these steps: Set up WordPress with web-based GUI =================================== -Recall that you created a database and user when you installed phpMyAdmin during -:ref:`Creating a Clear Linux based web server `. Next, you must +Recall that you created a database and user when you installed phpMyAdmin when you +set up a |CL| based :ref:`web server `. Next, you must connect WordPress to the database and install WordPress. -To continue with the setup, go to: http:///blog/wp-admin/install.php. +To continue with the setup, go to: http:///blog/wp-admin/install.php. The WordPress language option screen appears, as shown in figure 1. #. Select :guilabel:`English` and click :guilabel:`Continue`. @@ -99,7 +99,7 @@ The WordPress language option screen appears, as shown in figure 1. `Figure 1: WordPress language selection screen.` - The WordPress installation continues until the Welcome screen appears, as shown in + The WordPress installation continues until the Welcome screen appears, as shown in figure 2: .. figure:: figures/wp-install-2.png @@ -110,9 +110,9 @@ The WordPress language option screen appears, as shown in figure 1. #. Click :guilabel:`Let’s go!`. -#. Enter database connection specifics in the screen that appears, as shown in figure 3 +#. Enter database connection specifics in the screen that appears, as shown in figure 3 below. - + * Database name: WordPress * Database username: wordpressuser * Database password: wp-example (asterisks will not appear in the text box) @@ -127,7 +127,7 @@ The WordPress language option screen appears, as shown in figure 1. #. Click :guilabel:`Submit` to complete the setup. - Figure 4 shows the confirmation screen that verifies a successful setup. WordPress + Figure 4 shows the confirmation screen that verifies a successful setup. WordPress is connected to the MariaDB database. .. figure:: figures/wp-install-4.png @@ -142,7 +142,7 @@ The WordPress language option screen appears, as shown in figure 1. Complete successful login ========================= -Once the installation is complete, you can name your blog and create a WordPress username +Once the installation is complete, you can name your blog and create a WordPress username and password. See figure 5. .. figure:: figures/wp-install-5.png