Skip to content

Commit

Permalink
docs: PE-5671: systemd-timesyncd local host prerequisite for Local …
Browse files Browse the repository at this point in the history
…UI agent mode servers with NTP configs (#4879)

* Added systemd-timesyncd prerquisite for Local UI agent mode servers with NTP configs

* Minor clarification + exchanging Network Time Protocol for NTP initialism

* Updated parameters in step 7 to match UI verbiage, order, and casing

* Fixed SSH and NTP order

* ci: auto-formatting prettier issues

* Incorporating Karl's `systemd-timesyncd` manual suggestion

Co-authored-by: Karl Cardenas <[email protected]>

* ci: auto-formatting prettier issues

* Added systemd-timesyncd as a limitation/prerequisite to the Install Palette Agent page and added systemd-timesyncd man link

* ci: auto-formatting prettier issues

* Accepting Karl's limitation expansion

Co-authored-by: Karl Cardenas <[email protected]>

* ci: auto-formatting prettier issues

* Changed systemd to monospace

---------

Co-authored-by: Amanda Churi Filanowski <[email protected]>
Co-authored-by: achuribooks <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>
  • Loading branch information
4 people authored Dec 6, 2024
1 parent 98762f8 commit 7e075ad
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ through how to create a cluster using Local UI.

- Network access to the Edge device’s IP and port where Local UI is exposed. The default port is 5080.

- Credentials to log into Local UI. Any OS user can be used to log in to Local UI.
- Credentials to log in to Local UI. Any OS user can be used to log in to Local UI.

- You have uploaded the necessary software artifacts to the Edge host or included the artifacts in the Edge Installer
ISO during EdgeForge. For more information, refer to [Upload Content Bundle](./upload-content-bundle.md) and
Expand All @@ -38,9 +38,14 @@ through how to create a cluster using Local UI.
- Enable network overlay on your Edge cluster. Network overlay can only be enabled during cluster creation. For more
information about network overlay, refer to [Enable Overlay Network](../../networking/vxlan-overlay.md).

- If you configure a local [Agent Mode](../../../../deployment-modes/agent-mode/agent-mode.md) cluster to use Network
Time Protocol (NTP) servers, you must have
[`systemd-timesyncd`](https://www.freedesktop.org/software/systemd/man/latest/systemd-timesyncd.service.html)
installed and enabled on your host.

## Create Local Cluster

1. Log into Local UI by visiting the 5080 port of your Edge device's IP address or domain name. For more information,
1. Log in to Local UI by visiting the 5080 port of your Edge device's IP address or domain name. For more information,
refer to [Access Local UI](../host-management/access-console.md).

2. From the left **Main Menu**, click **Cluster**.
Expand Down Expand Up @@ -72,13 +77,13 @@ through how to create a cluster using Local UI.
Enter the values for the profile variables and click **Next**.

7. In the **Cluster Config** step, enter a virtual IP address to be used by your cluster. Optionally, you can also
specify a Network Time Protocol server and an SSH public key.
specify an NTP server and an SSH public key.

| Parameter | Description |
| --------------------------- | --------------------------------------------------------------------------------------------- |
| Network Time Protocol (NTP) | Specify the IP address for any Network Time Protocol (NTP) servers the cluster can reference. |
| SSH keys | Provide the public key of an SSH key pair that you will use to connect to the Edge host. |
| Virtual IP address | Provide the virtual IP address to be used by the cluster. |
| Parameter | Description |
| --------------------------- | ---------------------------------------------------------------------------------------- |
| Virtual IP Address (VIP) | Provide the virtual IP address to be used by the cluster. |
| Network Time Protocol (NTP) | Specify the IP address for any NTP servers the cluster can reference. |
| SSH Keys | Provide the public key of an SSH key pair that you will use to connect to the Edge host. |

Optionally, you can also enable network overlay, especially if your cluster will operate in an DHCP environment. For
more information, refer to [Enable Overlay Network](../../networking/vxlan-overlay.md). If you enable the overlay
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ Palette. You will then create a cluster profile and use the registered host to d

- Clusters with Flannel CNI is not verified for airgap deployments.

- Agent mode is only supported on Linux distributions that have
[`systemd`](https://www.freedesktop.org/software/systemd/man/latest/systemd.html) installed and available.

## Prerequisites

- A physical or virtual host with SSH access, access to the internet, and connection to Palette. For airgap deployments,
Expand All @@ -61,6 +64,7 @@ Palette. You will then create a cluster profile and use the registered host to d
- [jq](https://jqlang.github.io/jq/download/)
- [Zstandard](https://facebook.github.io/zstd/)
- [Rsync](https://github.com/RsyncProject/rsync)
- [`systemd-timesyncd`](https://www.freedesktop.org/software/systemd/man/latest/systemd-timesyncd.service.html)
- [conntrack](https://conntrack-tools.netfilter.org/downloads.html). This requirement is specific for clusters that
use PXKE as the Kubernetes layer.
- (Airgap only) [Crane](https://github.com/google/go-containerregistry/blob/main/cmd/crane/README.md) is installed and
Expand Down

0 comments on commit 7e075ad

Please sign in to comment.