Skip to content

Commit b96c4ad

Browse files
doc updated for gitea and nginx change (#414)
* updated doc for haproxy change * updated gitea tag/version uses * updated tinkerbell-nginx to tinkerbell-haproxy * updated doc * Update on_prem_upgrade.rst * Update on_prem_upgrade.rst updated rke2 version * Update on_prem_upgrade.rst * Update on_prem_upgrade.rst --------- Co-authored-by: PalashGoelIntel <palash.goel@intel.com>
1 parent b2d959c commit b96c4ad

File tree

18 files changed

+56
-43
lines changed

18 files changed

+56
-43
lines changed

docs/deployment_guide/on_prem_deployment/on_prem_deployment_profiles/on_prem_oxm_profile.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ A sample network topology is presented in the diagram below:
5151
#. Most of Edge Orchestrator services are accessible via ``TRAEFIK_IP``, a Virtual IP reserved in the local subnet.
5252

5353
#. The Edge Orchestrator must be configured with two more Virtual IPs that are reserved in the local subnet. ``ARGO_IP`` is used to access
54-
ArgoCD server, while ``NGINX_IP`` exposes installation artifacts that are downloaded by Edge Nodes during OS provisioning.
54+
ArgoCD server, while ``HAPROXY_IP`` exposes installation artifacts that are downloaded by Edge Nodes during OS provisioning.
5555

56-
#. Note that one of ``TRAEFIK_IP``, ``NGINX_IP`` and ``ARGO_IP`` can be same as the physical interface's IP address (``ARGO_IP`` in the example).
56+
#. Note that one of ``TRAEFIK_IP``, ``HAPROXY_IP`` and ``ARGO_IP`` can be same as the physical interface's IP address (``ARGO_IP`` in the example).
5757

5858
#. Only the PXE server is attached to the host networking and binds to the IP address of the physical network interface to listen to DHCP requests.
5959

@@ -156,7 +156,7 @@ Post-installation steps
156156
.. code-block:: shell
157157
158158
address=/[on.prem.domain.name]/[traefik-external-ip]
159-
address=/tinkerbell-nginx.[on.prem.domain.name]/[ingress-nginx-external-ip]
159+
address=/tinkerbell-haproxy.[on.prem.domain.name]/[ingress-nginx-external-ip]
160160
161161
#. Retrieve the self-signed Edge Orchestrator certificate and install it to the trust store.
162162

docs/deployment_guide/on_prem_deployment/on_prem_get_started/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Firewall Configuration
8585
The following table lists the network endpoints for Edge Orchestrator and edge nodes, which you can use to configure firewall rules tailored to your network environment.
8686

8787
* ArgoCD Admin UI at ``argo.{domain}``. Intel recommends that you restrict the incoming traffic to a subset of known source IPs because this is an administrator interface.
88-
* BIOS Onboarding accesses ``tinkerbell-nginx.{domain}``.
88+
* BIOS Onboarding accesses ``tinkerbell-haproxy.{domain}``.
8989
* You can access all other services from edge nodes agents, UI, and APIs of Edge Orchestrator.
9090

9191
.. list-table:: Network Endpoints for Edge Orchestrator and Edge Nodes
@@ -252,7 +252,7 @@ The following table lists the network endpoints for Edge Orchestrator and edge n
252252
- 443
253253
- Edge infrastructure management
254254
* - Edge node
255-
- tinkerbell-nginx.{domain}
255+
- tinkerbell-haproxy.{domain}
256256
- TCP
257257
- 443
258258
- BIOS onboarding

docs/deployment_guide/on_prem_deployment/on_prem_get_started/on_prem_install.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,10 @@ Core Deployment Configuration
103103
- ``registry-rs.edgeorchestration.intel.com``
104104
* - ``DEPLOY_VERSION``
105105
- Version of Edge Orchestrator to deploy
106-
- ``v2025.2.0``
106+
- ``v2026.0.0``
107+
* - ``DEPLOY_REPO_BRANCH``
108+
- Git tag or branch for deployment repository (overrides default commit)
109+
- ``v2026.0.0``
107110
* - ``ORCH_INSTALLER_PROFILE``
108111
- Deployment profile for Edge Orchestrator
109112
- ``onprem``
@@ -144,8 +147,8 @@ Network Configuration
144147
* - ``TRAEFIK_IP``
145148
- MetalLB IP address for Traefik
146149
- (empty)
147-
* - ``NGINX_IP``
148-
- MetalLB IP address for NGINX
150+
* - ``HAPROXY_IP``
151+
- MetalLB IP address for HAProxy
149152
- (empty)
150153
151154
Container Registry Configuration
@@ -787,7 +790,7 @@ An example of the `dnsmasq` config file:
787790
address=/vnc.[on.prem.domain.name]/[traefik-external-ip]
788791
address=/web-ui.[on.prem.domain.name]/[traefik-external-ip]
789792
address=/ws-app-service-proxy.[on.prem.domain.name]/[traefik-external-ip]
790-
address=/tinkerbell-nginx.[on.prem.domain.name]/[ingress-nginx-external-ip]
793+
address=/tinkerbell-haproxy.[on.prem.domain.name]/[ingress-nginx-external-ip]
791794
address=/mps.[on.prem.domain.name]/[traefik-external-ip]
792795
address=/rps.[on.prem.domain.name]/[traefik-external-ip]
793796
address=/mps-wss.[on.prem.domain.name]/[traefik-external-ip]

docs/deployment_guide/on_prem_deployment/on_prem_how_to/on_prem_upgrade.rst

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
On-Prem Upgrade Guide
22
=========================
33

4-
**Upgrade Path:** EMF On-Prem v3.1.3v2025.2.0
4+
**Upgrade Path:** EMF On-Prem v2025.2.0v2026.0.0
55

66
**Document Version:** 1.0
77

88
Overview
99
--------
1010

1111
This document provides step-by-step instructions to upgrade
12-
On-Prem Edge Manageability Framework (EMF) from version v3.1.3 to v2025.2.0.
12+
On-Prem Edge Manageability Framework (EMF) from version v2025.2.0 to v2026.0.0
1313

1414
Prerequisites
1515
-------------
1616

1717
System Requirements
1818
~~~~~~~~~~~~~~~~~~~
1919

20-
- Current EMF On-Prem installation version 3.1.3 or later
20+
- Current EMF On-Prem installation version v2025.2.0 or later
2121
- Root/sudo privileges on orchestrator node
2222
- PostgreSQL service running and accessible
2323
- Sufficient disk space for backups (~200GB minimum)
@@ -53,7 +53,7 @@ Step 1: Download the Latest On-Prem Upgrade Script
5353
REGISTRY_URL='registry-rs.edgeorchestration.intel.com'
5454
RS_PATH='edge-orch/common/files/on-prem'
5555
ORAS_VERSION='1.1.0'
56-
ORCH_VERSION='v2025.2.0'
56+
ORCH_VERSION='v2026.0.0'
5757
5858
# Install oras if not already installed
5959
if ! command -v oras &> /dev/null; then
@@ -135,7 +135,10 @@ Core Deployment Configuration
135135
- ``registry-rs.edgeorchestration.intel.com``
136136
* - ``DEPLOY_VERSION``
137137
- Version of Edge Orchestrator to deploy
138-
- ``v2025.2.0``
138+
- ``v2026.0.0``
139+
* - ``DEPLOY_REPO_BRANCH``
140+
- Git tag or branch for edge-manageability-framework deployment repository
141+
- ``v2026.0.0``
139142
* - ``ORCH_INSTALLER_PROFILE``
140143
- Deployment profile for Edge Orchestrator
141144
- ``onprem``
@@ -176,10 +179,14 @@ Network Configuration
176179
* - ``TRAEFIK_IP``
177180
- MetalLB IP address for Traefik
178181
- (empty)
179-
* - ``NGINX_IP``
180-
- MetalLB IP address for NGINX
182+
* - ``HAPROXY_IP``
183+
- MetalLB IP address for HAProxy
181184
- (empty)
182185
186+
.. note::
187+
In **v2026.0.0 (latest release)**, the ingress controller was **replaced from NGINX to HAProxy**.
188+
Please check whether the DNS entry for HAProxy is present after installation .
189+
183190
Container Registry Configuration
184191
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
185192
@@ -335,6 +342,7 @@ Update the following sections:
335342
- **CORE DEPLOYMENT CONFIGURATION:**
336343
- RELEASE_SERVICE_URL
337344
- DEPLOY_VERSION
345+
- DEPLOY_REPO_BRANCH
338346
- ORCH_INSTALLER_PROFILE
339347
340348
- **AUTHENTICATION & SECURITY:**
@@ -343,7 +351,7 @@ Update the following sections:
343351
344352
- **NETWORK CONFIGURATION:**
345353
- CLUSTER_DOMAIN
346-
- ARGO_IP, TRAEFIK_IP, NGINX_IP
354+
- ARGO_IP, TRAEFIK_IP, HAPROXY_IP
347355
348356
- **CONTAINER REGISTRY:**
349357
- GITEA_IMAGE_REGISTRY
@@ -367,8 +375,10 @@ Update the following sections:
367375
kubectl get svc traefik -n orch-gateway
368376
kubectl get svc ingress-nginx-controller -n orch-boots
369377
370-
# Set deployment version (replace with your actual upgrade version tag)
371-
export DEPLOY_VERSION=v2025.2.0
378+
# Set deployment version (replace with your actual upgrade version tag)
379+
export DEPLOY_VERSION=v2026.0.0
380+
#Set the deploy repo release tag/branch (Gitea commit/tag/branch from EMF repo)
381+
export DEPLOY_REPO_BRANCH=v2026.0.0
372382
373383
# Set non-interactive mode to true to skip prompts
374384
export PROCEED=true
@@ -427,7 +437,7 @@ Before confirming in Terminal 1, open **Terminal 2** and update configurations:
427437
# Check current LoadBalancer IPs
428438
kubectl get svc argocd-server -n argocd
429439
kubectl get svc traefik -n orch-gateway
430-
kubectl get svc ingress-nginx-controller -n orch-boots
440+
kubectl get svc ingress-haproxy-kubernetes-ingress -n orch-boots
431441
432442
# Verify LB IP configurations are updated
433443
nano repo_archives/tmp/edge-manageability-framework/orch-configs/clusters/onprem.yaml
@@ -451,7 +461,7 @@ Step 7: Monitor Upgrade Progress
451461
452462
The upgrade process includes:
453463
454-
- Upgrade RKE2 to 1.34.1 versions
464+
- Upgrade RKE2 to 1.34.4 versions
455465
- OS Configuration upgrade
456466
- Gitea upgrade
457467
- ArgoCD upgrade
@@ -575,8 +585,8 @@ Verify that the ``signed_ipxe.efi`` image is downloaded using the freshly downlo
575585
# Delete both files before downloading
576586
rm -rf Full_server.crt signed_ipxe.efi
577587
export CLUSTER_DOMAIN=cluster.onprem
578-
wget https://tinkerbell-nginx.$CLUSTER_DOMAIN/tink-stack/keys/Full_server.crt --no-check-certificate --no-proxy -q -O Full_server.crt
579-
wget --ca-certificate=Full_server.crt https://tinkerbell-nginx.$CLUSTER_DOMAIN/tink-stack/signed_ipxe.efi -q -O signed_ipxe.efi
588+
wget https://tinkerbell-haproxy.$CLUSTER_DOMAIN/tink-stack/keys/Full_server.crt --no-check-certificate --no-proxy -q -O Full_server.crt
589+
wget --ca-certificate=Full_server.crt https://tinkerbell-haproxy.$CLUSTER_DOMAIN/tink-stack/signed_ipxe.efi -q -O signed_ipxe.efi
580590
581591
Once the above steps are successful, the orchestrator (Orch) is ready for onboarding new Edge Nodes (EN).
582592

docs/shared/shared_gs_firewall_config.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The following table lists the network endpoints for Edge Orchestrator and edge n
55

66
* ArgoCD Admin UI at ``argo.{domain}``. Intel recommends that you restrict the
77
incoming traffic to a subset of known source IPs because this is an administrator interface.
8-
* BIOS Onboarding accesses ``tinkerbell-nginx.{domain}``.
8+
* BIOS Onboarding accesses ``tinkerbell-haproxy.{domain}``.
99
* You can access all other services from edge nodes agents, UI, and APIs
1010
of Edge Orchestrator.
1111

@@ -113,7 +113,7 @@ The following table lists the network endpoints for Edge Orchestrator and edge n
113113
- TCP:443
114114
- Cluster orchestration
115115
* - Edge node
116-
- tinkerbell-nginx.{domain}
116+
- tinkerbell-haproxy.{domain}
117117
- TCP:443
118118
- BIOS onboarding
119119
* - Edge Orchestrator admin

docs/user_guide/advanced_functionality/pxe_provisioning_with_cloud_emf.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Regardless of the deployment option, the first step is to download the iPXE scri
5757

5858
.. code-block:: shell
5959
60-
wget https://tinkerbell-nginx.CLUSTER_FQDN/tink-stack/signed_ipxe.efi --no-check-certificate --no-proxy
60+
wget https://tinkerbell-haproxy.CLUSTER_FQDN/tink-stack/signed_ipxe.efi --no-check-certificate --no-proxy
6161
6262
.. note:: Replace CLUSTER_FQDN with the FQDN of the Edge Orchestrator.
6363

docs/user_guide/set_up_edge_infra/edge_node_onboard/https_boot/https_boot_dell.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ HTTPS boot is required to securely onboard devices.
2020
#. In iDRAC, go to **Configuration** > **BIOS Settings** > **Network Settings**.
2121
#. Set **HTTP Device1** to **Enabled**.
2222
#. Go to **HTTP Device1 Settings** > **Interface** and choose the NIC identified previously.
23-
#. Set the **URI** to ``https://tinkerbell-nginx.CLUSTER_FQDN/tink-stack/signed_ipxe.efi``
23+
#. Set the **URI** to ``https://tinkerbell-haproxy.CLUSTER_FQDN/tink-stack/signed_ipxe.efi``
2424
path. This value is defined during installation of |software_prod_name|.
2525

2626
.. note:: Replace CLUSTER_FQDN with the name of the domain of the Edge Orchestrator.

docs/user_guide/set_up_edge_infra/edge_node_onboard/https_boot/https_boot_lenovo.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ Prepare the ISO image one time, so that it will be mounted as Virtual Media on t
1313

1414
.. code-block:: shell
1515
16-
wget https://tinkerbell-nginx.${CLUSTER_FQDN}/tink-stack/keys/Full_server.crt --no-check-certificate --no-proxy
16+
wget https://tinkerbell-haproxy.${CLUSTER_FQDN}/tink-stack/keys/Full_server.crt --no-check-certificate --no-proxy
1717
1818
#. Use the following command to download the secure boot certificate for iPXE and Hook Os, independent of final OS.
1919
This is step is not required if **Secure Boot** is not enabled.
2020
Replace CLUSTER_FQDN with the name of the domain that is used during installation.
2121

2222
.. code-block:: shell
2323
24-
wget https://tinkerbell-nginx.${CLUSTER_FQDN}/tink-stack/keys/db.der --no-check-certificate --no-proxy
24+
wget https://tinkerbell-haproxy.${CLUSTER_FQDN}/tink-stack/keys/db.der --no-check-certificate --no-proxy
2525
2626
For Edge Microvisor Toolkit, if Secure Boot (SB) is enabled (Not required for Ubuntu):
2727

@@ -142,7 +142,7 @@ HTTP Boot Option
142142
:alt: Boot Option
143143
:width: 750px
144144

145-
#. Set **Boot URI** to ``https://tinkerbell-nginx.CLUSTER_FQDN/tink-stack/signed_ipxe.efi``. This value is defined during installation of |software_prod_name|\ .
145+
#. Set **Boot URI** to ``https://tinkerbell-haproxy.CLUSTER_FQDN/tink-stack/signed_ipxe.efi``. This value is defined during installation of |software_prod_name|\ .
146146

147147
.. note:: Replace CLUSTER_FQDN with the domain name of |software_prod_name|\ .
148148

docs/user_guide/set_up_edge_infra/edge_node_onboard/https_boot/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Requirements
1919
HTTPS-assisted boot flow
2020
------------------------
2121

22-
#. Configure BIOS with UEFI HTTP URL pointing to ``https://tinkerbell-nginx.CLUSTER_FQDN/tink-stack/signed_ipxe.efi``.
22+
.#. Configure BIOS with UEFI HTTP URL pointing to ``https://tinkerbell-haproxy.CLUSTER_FQDN/tink-stack/signed_ipxe.efi``.
2323

2424
#. Optionally, if Edge Nodes have been configured with Secure Boot, configure BIOS to enable Secure Boot and upload |software_prod_name| CA certificates.
2525

docs/user_guide/set_up_edge_infra/edge_node_onboard/prerequisites/racadm_on_linux.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Install RACADM on Linux PC
3232
NODE_BMC_PWD="Your iDRAC password"
3333
3434
CLUSTER_FQDN="Your cluster FQDN established when deploying Edge Orchestrator"
35-
TINK_FQDN=tinkerbell-nginx.${CLUSTER_FQDN}
35+
TINK_FQDN=tinkerbell-haproxy.${CLUSTER_FQDN}
3636
3737
# RACADM login
3838
LOGIN="-r ${NODE_BMC_IP} -u ${NODE_BMC_USER} -p ${NODE_BMC_PWD} --nocertwarn"

0 commit comments

Comments
 (0)