Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
424 changes: 8 additions & 416 deletions docs/anax/docs/cluster_install.md

Large diffs are not rendered by default.

32 changes: 32 additions & 0 deletions docs/anax/docs/configuring_storage_class.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
copyright: Contributors to the Open Horizon project
years: 2022 - 2026
title: Configuring a storage class
description: Documentation for configuring storage class for edge cluster agents
lastupdated: 2026-01-30
nav_order: 21
parent: Agent (anax)
has_children: false
has_toc: false
---

{:new_window: target="blank"}
{:shortdesc: .shortdesc}
{:screen: .screen}
{:codeblock: .codeblock}
{:pre: .pre}
{:child: .link .ulchildlink}
{:childlinks: .ullinks}

# Configuring a storage class
{: #configuring_storage_class}

## StorageClass attribute
{: #storageclass_attribute}

A PersistentVolumeClaim will be created during the agent install process. It will be used by agent to store data for agent and cronjob. The storageclass must satisfy the following requirements:
{:shortdesc}

- Supports both read and write
- Can be made available immediately
- Supports `ReadWriteMany` mode if agent is running in multi-node cluster
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
copyright: Contributors to the Open Horizon project
years: 2022 - 2025
title: Deploying services to an edge cluster
years: 2022 - 2026
title: Deploying services to your edge cluster
description: Documentation for Deploying services to an edge cluster
lastupdated: 2025-05-03
nav_order: 3
parent: Edge clusters
lastupdated: 2026-01-30
nav_order: 20
parent: Agent (anax)
---

# Deploying services to an edge cluster
# Deploying services to your edge cluster

## How to deploy services to an edge cluster
{: #deploying_services}
Expand Down Expand Up @@ -104,4 +104,4 @@ Setting node policy on this edge cluster can cause deployment policies to deploy
hzn unregister -f
hzn register -n $HZN_EXCHANGE_NODE_AUTH -p <pattern-name>
```
{: codeblock}
{: codeblock}
29 changes: 27 additions & 2 deletions docs/anax/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
copyright: Contributors to the Open Horizon project
years: 2022 - 2025
years: 2022 - 2026
title: Agent (anax)
description: Open Horizon Anax Agent Documentation
lastupdated: 2025-05-03
lastupdated: 2026-01-30
nav_order: 5
has_children: True
has_toc: False
Expand All @@ -21,6 +21,31 @@ layout: page
# {{site.data.keyword.edge_notm}} Agent Documentation
{: #anaxdocs}

## Edge Cluster Agent Installation

### [Planning to install an edge cluster agent](planning_edge_cluster_agent.md)

Planning considerations for installing an edge cluster agent.

#### Preparing an edge cluster

* [Installing an OCP cluster](install_ocp_edge_cluster.md)
* [Setting up a local image registry for a Red Hat OpenShift Container Platform edge cluster](setting_up_ocp_image_registry.md)
* [Installing a K3s cluster](install_k3s_cluster.md)
* [Setup edge cluster local image registry for K3s](setup_k3s_image_registry.md)
* [Installing a microk8s cluster](install_microk8s_cluster.md)
* [Setup edge cluster local image registry for MicroK8s](setup_microk8s_image_registry.md)
* [Setting variables to use a remote image registry](setting_remote_image_registry.md)

#### Installing an edge cluster agent

* [Installing the agent on Red Hat OpenShift Container Platform Kubernetes edge cluster](installing_ocp_edge_cluster_agent.md)
* [Installing the agent on K3s and MicroK8s edge clusters](installing_k3s_microk8s_agent.md)
* [Deploying services to your edge cluster](deploying_services_cluster.md)
* [Configuring a storage class](configuring_storage_class.md)

### [Removing the agent from an edge cluster](removing_agent_from_cluster.md)

## [Agent authentication](authentication_overview.md)

There are different authentication methods for the anax agent to communicate with the {{site.data.keyword.edge_notm}} Management Hub.
Expand Down
63 changes: 63 additions & 0 deletions docs/anax/docs/install_k3s_cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
copyright: Contributors to the Open Horizon project
years: 2022 - 2026
title: Installing a K3s cluster
description: Documentation for installing a K3s edge cluster
lastupdated: 2026-01-30
nav_order: 13
parent: Planning to install an edge cluster agent
grand_parent: Agent (anax)
has_children: false
has_toc: false
---

{:new_window: target="blank"}
{:shortdesc: .shortdesc}
{:screen: .screen}
{:codeblock: .codeblock}
{:pre: .pre}
{:child: .link .ulchildlink}
{:childlinks: .ullinks}

# Installing a K3s cluster
{: #install_k3s_cluster}

This content provides a summary of how to install K3s, a lightweight and small Kubernetes cluster, on [Ubuntu 22.04.4 LTS ](https://ubuntu.com/download/server){:target="_blank"}{: .externalLink}. For more information, see [the K3s documentation ](https://docs.k3s.io/){:target="_blank"}{: .externalLink}.
{:shortdesc}

**Note**: If installed, uninstall kubectl before completing the following steps.

## Procedure

1. Either login as root or elevate to root with `sudo -i`

2. The full hostname of your machine must contain at least two dots. Check the full hostname:

```bash
hostname
```
{: codeblock}

If you need to update it (for example, from `k3s` to `k.3.s`), use the following pattern:

```bash
hostnamectl hostname k.3.s
```
{: codeblock}

3. Install K3s:

```bash
curl -sfL https://get.k3s.io | sh -
```
{: codeblock}

4. Choose the image registry types: remote image registry or edge cluster local registry. Image registry is the place that will hold the agent image and agent cronjob image.

- [Setting variables to use a remote image registry](setting_remote_image_registry.md)
- [Setup edge cluster local image registry for K3s](setup_k3s_image_registry.md)

## What's next

* [Setup edge cluster local image registry for K3s](setup_k3s_image_registry.md)
* [Installing the agent on K3s and MicroK8s edge clusters](installing_k3s_microk8s_agent.md)
90 changes: 90 additions & 0 deletions docs/anax/docs/install_microk8s_cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
copyright: Contributors to the Open Horizon project
years: 2022 - 2026
title: Installing a microk8s cluster
description: Documentation for installing a MicroK8s edge cluster
lastupdated: 2026-01-30
nav_order: 15
parent: Planning to install an edge cluster agent
grand_parent: Agent (anax)
has_children: false
has_toc: false
---

{:new_window: target="blank"}
{:shortdesc: .shortdesc}
{:screen: .screen}
{:codeblock: .codeblock}
{:pre: .pre}
{:child: .link .ulchildlink}
{:childlinks: .ullinks}

# Installing a microk8s cluster
{: #install_microk8s_cluster}

This content provides a summary of how to install MicroK8s, a lightweight and small Kubernetes cluster, on Ubuntu 22.04.4 LTS. (For more information, see the MicroK8s documentation.)
{:shortdesc}

**Note**: This type of edge cluster is meant for development and test because a single worker node Kubernetes cluster does not provide scalability or high availability.

## Procedure

1. Install MicroK8s:

```bash
sudo snap install microk8s --classic --channel=stable
```
{: codeblock}

2. If you are not running as root, add your user to the MicroK8s group:

```bash
sudo usermod -a -G microk8s $USER
sudo chown -f -R $USER ~/.kube
su - $USER
```
{: codeblock}

3. Enable dns and storage modules in MicroK8s:

```bash
microk8s.enable dns
microk8s.enable hostpath-storage
```
{: codeblock}

**Note**: MicroK8s uses 8.8.8.8 and 8.8.4.4 as upstream name servers by default. If these name servers cannot resolve the management hub hostname, you must change the name servers that MicroK8s is using:

a. Retrieve the list of upstream name servers in `/etc/resolv.conf` or `/run/system/resolve/resolv.conf`

b. Edit coredns configmap in the kube-system namespace. Set the upstream nameservers in the forward section:

```bash
microk8s.kubectl edit -n kube-system cm/coredns
```
{: codeblock}

4. Check the status:

```bash
microk8s.status --wait-ready
```
{: codeblock}

5. The MicroK8s kubectl command is called microk8s.kubectl to prevent conflicts with an already install kubectl command. Assuming that kubectl is not installed, add this alias for microk8s.kubectl:

```bash
echo 'alias kubectl=microk8s.kubectl' >> ~/.bash_aliases
source ~/.bash_aliases
```
{: codeblock}

6. Choose the image registry types: remote image registry or edge cluster local registry. Image registry is the place that will hold the agent image and agent cronjob image.

- [Setting variables to use a remote image registry](setting_remote_image_registry.md)
- [Setup edge cluster local image registry for MicroK8s](setup_microk8s_image_registry.md)

## What's next

* [Setup edge cluster local image registry for MicroK8s](setup_microk8s_image_registry.md)
* [Installing the agent on K3s and MicroK8s edge clusters](installing_k3s_microk8s_agent.md)
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
copyright: Contributors to the Open Horizon project
years: 2020 - 2025
title: Installing an OCP edge cluster
years: 2020 - 2026
title: Installing an OCP cluster
description: Documentation for Installing an OCP edge cluster
lastupdated: 2025-05-03
nav_order: 3
parent: Preparing an edge cluster
has_children: False
has_toc: False
grand_parent: Edge clusters
lastupdated: 2026-01-30
nav_order: 11
parent: Planning to install an edge cluster agent
grand_parent: Agent (anax)
has_children: false
has_toc: false
---

{:new_window: target="blank"}
Expand All @@ -19,13 +19,14 @@ grand_parent: Edge clusters
{:child: .link .ulchildlink}
{:childlinks: .ullinks}

# Installing an OCP edge cluster
# Installing an OCP cluster
{: #install_ocp_edge_cluster}

1. Install OCP by following the installation instructions in the [{{site.data.keyword.open_shift_cp}} Documentation ](https://docs.openshift.com/container-platform/4.6/welcome/index.html){:target="_blank"}{: .externalLink}. ({{site.data.keyword.ieam}} only supports OCP on x86_64 platforms.)

2. Install the Kubernetes CLI (**kubectl**), Openshift client CLI (**oc**) and Docker on the admin host where you administer your OCP edge cluster. This is the same host where you run the agent installation script. For more information, see [Installing cloudctl, kubectl, and oc](../cli/cloudctl_oc_cli.md).
2. Install the Kubernetes CLI (**kubectl**), Openshift client CLI (**oc**) and Docker on the admin host where you administer your OCP edge cluster. This is the same host where you run the agent installation script. For more information, see [Installing cloudctl, kubectl, and oc](../../cli/cloudctl_oc_cli.md).

## What's next

* [Installing the Cluster Agent](./edge_cluster_agent.md)
* [Setting up a local image registry for a Red Hat OpenShift Container Platform edge cluster](setting_up_ocp_image_registry.md)
* [Installing the agent on Red Hat OpenShift Container Platform Kubernetes edge cluster](installing_ocp_edge_cluster_agent.md)
Loading