From 8c969f06b3d2f6ebdd6d686797dd33600ce528bd Mon Sep 17 00:00:00 2001 From: Brian Clemens Date: Wed, 3 Mar 2021 22:24:09 +0900 Subject: [PATCH] reformat el7 quickstart --- docs/docs/getting-started/quickstart-el7.md | 178 ++++++++++---------- docs/package.json | 2 +- 2 files changed, 87 insertions(+), 93 deletions(-) diff --git a/docs/docs/getting-started/quickstart-el7.md b/docs/docs/getting-started/quickstart-el7.md index f2da5240..16af545b 100644 --- a/docs/docs/getting-started/quickstart-el7.md +++ b/docs/docs/getting-started/quickstart-el7.md @@ -3,136 +3,130 @@ id: quickstart-el7 title: Quick Start for RHEL and CentOS 7 --- -Install Warewulf and dependencies -================================= +## Install Warewulf and dependencies -.. code-block:: bash +```bash +$ sudo yum install epel-release +$ sudo yum install golang tftp-server dhcp nfs-utils - $ sudo yum install epel-release - $ sudo yum install golang tftp-server dhcp nfs-utils +$ sudo systemctl stop firewalld +$ sudo systemctl disable firewalld - $ sudo systemctl stop firewalld - $ sudo systemctl disable firewalld +$ git clone https://github.com/ctrliq/warewulf.git +$ cd warewulf +$ make all +$ sudo make install +``` - $ git clone https://github.com/ctrliq/warewulf.git - $ cd warewulf - $ make all - $ sudo make install +## Configure the controller -Configure the controller -======================== +Edit the file `/etc/warewulf/warewulf.conf` and ensure that you've set the appropriate configuration paramaters. Here are some of the defaults for reference: -Edit the file ``/etc/warewulf/warewulf.conf`` and ensure that you've set the appropriate configuration paramaters. Here are some of the defaults for reference: +```yaml +ipaddr: 192.168.1.1 +netmask: 255.255.255.0 +warewulf: + port: 9873 + secure: true + update interval: 60 +dhcp: + enabled: true + range start: 192.168.1.150 + range end: 192.168.1.200 + template: default + systemd name: dhcpd +tftp: + enabled: true + tftproot: /var/lib/tftpboot + systemd name: tftp +nfs: + systemd name: nfs-server + exports: + - /home + - /var/warewulf +``` -.. code-block:: yaml +## Configure system services automatically - ipaddr: 192.168.1.1 - netmask: 255.255.255.0 - warewulf: - port: 9873 - secure: true - update interval: 60 - dhcp: - enabled: true - range start: 192.168.1.150 - range end: 192.168.1.200 - template: default - systemd name: dhcpd - tftp: - enabled: true - tftproot: /var/lib/tftpboot - systemd name: tftp - nfs: - systemd name: nfs-server - exports: - - /home - - /var/warewulf +```bash +$ sudo wwctl configure dhcp # Create the default dhcpd.conf file and start/enable service +$ sudo wwctl configure tftp # Install the base tftp/PXE boot files and start/enable service +$ sudo wwctl configure nfs # Configure the exports and create an fstab in the default system overlay +$ sudo wwctl configure ssh # Build the basic ssh keys to be included by the default system overlay +``` -Configure system services automatically -======================================= - -.. code-block:: bash - - $ sudo wwctl configure dhcp # Create the default dhcpd.conf file and start/enable service - $ sudo wwctl configure tftp # Install the base tftp/PXE boot files and start/enable service - $ sudo wwctl configure nfs # Configure the exports and create an fstab in the default system overlay - $ sudo wwctl configure ssh # Build the basic ssh keys to be included by the default system overlay - -Pull and build the VNFS container and kernel -============================================ +## Pull and build the VNFS container and kernel This will pull a basic VNFS container from Docker Hub and import the default running kernel from the controller node and set both in the "default" node profile. -.. code-block:: bash +```bash +$ sudo wwctl container import docker://warewulf/centos-7 centos-7 --setdefault +$ sudo wwctl kernel import $(uname -r) --setdefault +``` - $ sudo wwctl container import docker://warewulf/centos-7 centos-7 --setdefault - $ sudo wwctl kernel import $(uname -r) --setdefault +## Set up the default node profile -Set up the default node profile -=============================== +The `--setdefault` arguments above will automatically set those entries in the default profile, but if you wanted to set them by hand to something different, you can do the following: -The ``--setdefault`` arguments above will automatically set those entries in the default profile, but if you wanted to set them by hand to something different, you can do the following: - -.. code-block:: bash - - $ sudo wwctl profile set default -K $(uname -r) -C centos-7 +```bash +$ sudo wwctl profile set default -K $(uname -r) -C centos-7 +``` Next we set some default networking configurations for the first ethernet device. On modern Linux distributions, the name of the device is not critical, as it will be setup according to the HW address. Because all nodes will share the netmask and gateway configuration, we can set them in the default profile as follows: -.. code-block:: bash +```bash +$ sudo wwctl profile set default --netdev eth0 -M 255.255.255.0 -G 192.168.1.1 +$ sudo wwctl profile list +``` - $ sudo wwctl profile set default --netdev eth0 -M 255.255.255.0 -G 192.168.1.1 - $ sudo wwctl profile list +## Add a node and build node specific overlays -Add a node and build node specific overlays -=========================================== - -Adding nodes can be done while setting configurations in one command. Here we are setting the IP address of ``eth0`` and setting this node to be discoverable, which will then automatically have the HW address added to the configuration as the node boots. +Adding nodes can be done while setting configurations in one command. Here we are setting the IP address of `eth0` and setting this node to be discoverable, which will then automatically have the HW address added to the configuration as the node boots. Node names must be unique. If you have node groups and/or multiple clusters, designate them using dot notation. Note that the full node configuration comes from both cascading profiles and node configurations which always supersede profile configurations. -.. code-block:: bash +```bash +$ sudo wwctl node add n0000.cluster --netdev eth0 -I 192.168.1.100 --discoverable +$ sudo wwctl node list -a n0000 +``` - $ sudo wwctl node add n0000.cluster --netdev eth0 -I 192.168.1.100 --discoverable - $ sudo wwctl node list -a n0000 - -Warewulf Overlays -================= +## Warewulf Overlays There are two types of overlays: system and runtime overlays. -System overlays are provisioned to the node before ``/sbin/init`` is called. This enables us to prepopulate node configurations with content that is node specific like networking and service configurations. +System overlays are provisioned to the node before `/sbin/init` is called. This enables us to prepopulate node configurations with content that is node specific like networking and service configurations. Runtime overlays are provisioned after the node has booted and periodically during the normal runtime of the node. Because these overlays are provisioned at periodic intervals, they are very useful for content that changes, like users and groups. -Overlays are generated from a template structure that is viewed using the ``wwctl overlay`` commands. Files that end in the ``.ww`` suffix are templates and abide by standard text/template rules. This supports loops, arrays, variables, and functions making overlays extremely flexible. +Overlays are generated from a template structure that is viewed using the `wwctl overlay` commands. Files that end in the ``.ww`` suffix are templates and abide by standard text/template rules. This supports loops, arrays, variables, and functions making overlays extremely flexible. -.. note:: - When using the overlay subsystem, system overlays are never shown by default. So when running ``overlay`` commands, you are always looking at runtime overlays unless the ``-s`` option is passed. +::: note + +When using the overlay subsystem, system overlays are never shown by default. So when running `overlay` commands, you are always looking at runtime overlays unless the `-s` option is passed. + +::: All overlays are compiled before being provisioned. This accelerates the provisioning process because there is less to do when nodes are being managed at scale. -Here are some of the common ``overlay`` commands: +Here are some of the common `overlay` commands: -.. code-block:: bash +```bash +$ sudo wwctl overlay list -l +$ sudo wwctl overlay list -ls +$ sudo wwctl overlay edit default /etc/hello_world.ww +$ sudo wwctl overlay build -a +``` - $ sudo wwctl overlay list -l - $ sudo wwctl overlay list -ls - $ sudo wwctl overlay edit default /etc/hello_world.ww - $ sudo wwctl overlay build -a +## Start the Warewulf daemon -Start the Warewulf daemon -------------------------- +Once the above provisioning images are built, you can check the provisioning readiness and then begin booting nodes. -Once the above provisioning images are built, you can check the provisioning "rediness" and then begin booting nodes. +```bash +$ sudo wwctl ready +$ sudo wwctl server start +$ sudo wwctl server status +``` -.. code-block:: bash - - $ sudo wwctl ready - $ sudo wwctl server start - $ sudo wwctl server status - -Boot your compute node and watch it boot ----------------------------------------- +## Boot your compute node and watch it boot diff --git a/docs/package.json b/docs/package.json index 678c543f..e881cd4b 100644 --- a/docs/package.json +++ b/docs/package.json @@ -31,4 +31,4 @@ "last 1 safari version" ] } -} \ No newline at end of file +}