Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: connected local UI #3764

Merged
merged 11 commits into from
Sep 10, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ Local UI allows you to upload content bundles to the Edge host. The content in t
create a single-node cluster consisting of the Edge host itself. You can also import cluster definitions, which is a
bundle of one or more cluster profiles and their profile variables, from Palette to define your Edge cluster.

Cluster operations in Local UI are only available to airgapped Edge hosts. You cannot use Local UI to create or manage
clusters, upload content bundles, or cluster definition on a connected Edge host. You must use Palette to manage the
cluster instead. For more information, refer to
[Create Cluster Definition](../../site-deployment/cluster-deployment.md).

:::preview

:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ sidebar_position: 30
tags: ["edge"]
---

You can create and manage a single-node cluster locally from Local UI. This page guides you through how to create a
cluster using Local UI.
You can create and manage a single-node cluster on an airgapped Edge host locally from Local UI. This page guides you
through how to create a cluster using Local UI.

:::preview

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ Silicon, use the API approach instead.

## Export Cluster Definition with Palette Edge CLI

You can export cluster definitions with the Palette Edge CLI. This approach allows you to create a content bundle at the
same time in a single command.

### Prerequisites

- At least one [cluster profile](/docs/docs-content/profiles/cluster-profiles/cluster-profiles.md) in Palette.
Expand Down Expand Up @@ -162,6 +165,9 @@ Silicon, use the API approach instead.

## Export Cluster Definition with Palette API

If you do not have an AMD64 machine, or you do not want to download and use the Palette Edge CLI, you can still export
cluster definitions using the Palette API.

### Prerequisites

- At least one [cluster profile](/docs/docs-content/profiles/cluster-profiles/cluster-profiles.md) in Palette.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ sidebar_position: 40
tags: ["edge"]
---

You can update existing local clusters from Local UI by uploading a new cluster profile version. This guide explains how
to update an existing cluster in Local UI.
You can update existing local clusters in an airgapped Edge host from Local UI by uploading a new cluster profile
version. This guide explains how to update an existing cluster in Local UI.

:::preview

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ sidebar_position: 60
tags: ["edge"]
---

You can build a content bundle and upload it to an Edge host through Local UI. The content you upload can include
images, helm charts, and packs. This allows you to provision clusters locally using the content you upload to the Edge
host when the host does not have a connection to a central Palette instance or an image repository.
You can build a content bundle and upload it to an airgapped Edge host through Local UI. The content you upload can
include images, helm charts, and packs. This allows you to provision clusters locally using the content you upload to
the Edge host when the host does not have a connection to a central Palette instance or an image repository.

This page guides you through how to build a content bundle and upload it to an Edge host using the Edge management
console.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,6 @@ This page guides you through how access the console, and log in, and manage your

- An Edge host installed with Edge Installer 4.3 or later.

- The Edge host does not have a connection to a Palette instance and the installation is conducted with the
`installationMode` parameter set to `airgap`. For more information, refer to
[Installer Configuration](../../edge-configuration/installer-reference.md).

- You have completed or skipped the initial configuration of the Edge host. For more information, refer to
[Edge Host Initial Configuration](../../site-deployment/site-installation/initial-setup.md).

- Network access to the Edge host's port where Local UI is exposed. The default port is 5080.

- Credentials to log in to Local UI. Any Operating System (OS) user can be used to log into Local UI.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ Palette agent's logs to another file if you want to collect the logs in a differ
By default, you can view one year's worth of audit logs in Local UI. Log files past the one year mark will be rotated
out and archived. You can still download your log files from any period, but they will not be viewable in Local UI.

### Limitations

- This feature is only available to airgapped Edge hosts without a connection to Palette.

### Prerequisites

- You must have configured your application to write logs to `syslog` with a given facility and severity level. We
Expand Down Expand Up @@ -146,7 +142,11 @@ entries that were not configured to be displayed in Local UI.

### Prerequisites

- An active Edge host installed in the `airgap` mode.
- An Edge host installed with Edge Installer 4.3 or later.

- Network access to the Edge host's port where Local UI is exposed. The default port is 5080.

- Credentials to log in to Local UI. Any Operating System (OS) user can be used to log into Local UI.

### Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ configured through Local UI will be retained even after a

- An Edge host deployed with Edge Installer 4.3 or later.

- The Edge host does not have a connection to a Palette instance and the installation is conducted with the
`installationMode` parameter set to `airgap`. For more information, refer to
[Installer Configuration](../../edge-configuration/installer-reference.md).

- An active HTTP proxy server.

## Configure HTTP Proxy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@ an air-gapped environment.

### Prerequisites

- You have access to Local UI.
- An Edge host installed with Edge Installer 4.3 or later.

- Network access to the Edge host's port where Local UI is exposed. The default port is 5080.

- Credentials to log in to Local UI. Any Operating System (OS) user can be used to log into Local UI.

### Use Ping to Check Connection to a Specific Endpoint

Expand Down Expand Up @@ -68,7 +72,11 @@ lost.

### Prerequisites

- You have access to Local UI.
- An Edge host installed with Edge Installer 4.3 or later.

- Network access to the Edge host's port where Local UI is exposed. The default port is 5080.

- Credentials to log in to Local UI. Any Operating System (OS) user can be used to log into Local UI.

### Use Traceroute to Check Connection to a Specific Endpoint

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ to this directory; it is not limited to core dump files.
- You have configured your applications to write files to `/var/log/files`. The steps to do this vary by application,
but the path must be exactly `/var/log/files`. This is the only path where files can be downloaded from Local UI.

- An operational Edge host installed in the `airgap` mode. For more information, refer to
[Installer Reference](../../edge-configuration/installer-reference.md).

- Network access to your Edge host's Local UI port. The default port is `5080`.

## Enablement
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Local UI allows you to manage your Edge host. You can configure Local UI to shut
to a factory default. You can also update credentials, update Local UI's branding and configure HTTP proxy for your Edge
host from Local UI.

Host management features, with exception of resetting the Edge host to factory setting, are available to both connected
and airgapped Edge hosts.

:::preview

:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,13 @@ Edge host is rebooting.

## Reset Edge Host to Factory Default

You can reset an Edge host to factory default from Local UI. This restores the Edge host to the state right after the
[initial configuration](../../site-deployment/site-installation/initial-setup.md) is completed in the Terminal User
Interface (TUI). Reset to factory default removes all workloads, content, and cluster definition from the Edge host.
This includes content bundles that were built into the ISO image during EdgeForge.
You can reset an airgapped Edge host to factory default from Local UI. This restores the Edge host to the state right
after the [initial configuration](../../site-deployment/site-installation/initial-setup.md) is completed in the Terminal
User Interface (TUI). Reset to factory default removes all workloads, content, and cluster definition from the Edge
host. This includes content bundles that were built into the ISO image during EdgeForge.

If your Edge host has a connection to Palette, you cannot reset the Edge host to factory default through Local UI as the
cluster is managed through Palette.

:::info

Expand Down
42 changes: 25 additions & 17 deletions docs/docs-content/clusters/edge/local-ui/local-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,30 @@ tags: ["edge"]
---

Once Palette Edge has been installed on the Edge host and the Edge host has gone through initial configuration, you will
be able to access Local UI. Local UI allows you to manage Edge hosts in your network locally, upload content bundles
containing images, Helm charts, and packs, and create Edge clusters locally in disconnected environments without
connections to a Palette instance.
be able to access Local UI.

- In airgapped Edge hosts, Local UI allows you to manage Edge hosts in your network locally, upload content bundles
containing images, Helm charts, and packs, and create Edge clusters locally in disconnected environments without
connections to a Palette instance.
- In connected Edge hosts, you cannot use the cluster-related functionalities because the cluster is managed by Palette,
but you can still utilize Local UI to configure and manage the Edge host itself.

:::preview

:::

![A diagram illustrating how users and use EdgeForge and Local UI to deploy clusters without a Palette connection](/clusters_edge_emc_workflow.webp)

:::warning

Local UI only works for Edge deployments in disconnected environments. A disconnected environment means that the Edge
host does not have a connection to a Palette instance. Do not use Local UI if your cluster has a connection to a Palette
instance.

:::

Refer to the follow resources to learn how to use Local UI to manage your disconnected Edge deployment:

## Get Started

- Refer to [Access Local UI](./host-management/access-console.md) for guidance on how to access Local UI and update your
credentials.

- If you already included a content bundle and a cluster definition in your installer ISO, you can create a cluster
using the resources in the ISO directly. Refer to [Create Local Cluster](./cluster-management/create-cluster.md) for
guidance. Refer to [EdgeForge Workflow](../edgeforge-workflow/edgeforge-workflow.md) for guidance on how to include
content bundles and cluster definitions in your ISO.
- If you already included a content bundle and a cluster definition in your installer ISO, you can create a cluster in
your airgapped Edge host using the resources in the ISO directly. Refer to
[Create Local Cluster](./cluster-management/create-cluster.md) for guidance. Refer to
[EdgeForge Workflow](../edgeforge-workflow/edgeforge-workflow.md) for guidance on how to include content bundles and
cluster definitions in your ISO.

- If you did not provide a content bundle or cluster definition, or if you want to provide new content from which to
build clusters, refer to the following guides to upload content bundles and export cluster definitions.
Expand All @@ -47,6 +42,8 @@ Refer to the follow resources to learn how to use Local UI to manage your discon

## Cluster Management

Cluster management features are only available to airgapped Edge hosts.

- [Upload Content Bundles](./cluster-management/upload-content-bundle.md)

- [Export Cluster Definition](./cluster-management/export-cluster-definition.md)
Expand All @@ -55,10 +52,21 @@ Refer to the follow resources to learn how to use Local UI to manage your discon

## Host Management

Most host management features, with the exception of Factory Reset, are available on both airgapped and connected Edge
hosts.

- [Access Local UI](./host-management/access-console.md)

- [Configure HTTP Proxy in Local UI](./host-management/configure-proxy.md)

- [Reset Edge Host to Factory Default](./host-management/reset-reboot.md)

- [Customize Local UI Theme](./host-management/theming.md)

- [Add Custom Link to Sidebar](./host-management/custom-link.md)

- [Troubleshooting with Diagnostic Tools](./host-management/diagnostic-tools.md)

- [Configure Audit Logs](./host-management/audit-logs.md)

- [Download Files](./host-management/download-files.md)