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: addresses PE-3308 and PE-3316 #1964

Merged
merged 11 commits into from
Jan 4, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
19 changes: 15 additions & 4 deletions docs/docs-content/clusters/edge/networking/vxlan-overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,18 @@ The Analytics team of a manufacturing company is deploying an Edge host to their

* At least one Edge host registered with your Palette account.
* Your cluster profile must have K3s as its Kubernetes distribution.
* All Edge hosts must be on the same network. You may provision your own virtual network to connect Edge hosts that are on different physical networks, but all Edge hosts to be included in the cluster must be on the same network before cluster creation.
* All Edge hosts must be on the same Layer-2 network.
* If your Edge hosts are using virtual ethernet adapters and you are using either Cilium or Flannel as your network adapter, ensure that you add the following commands in the **user-data** file at the boot stage.
lennessyy marked this conversation as resolved.
Show resolved Hide resolved
```yaml {2-6}
stages:
boot:
- name: "Disable UDP segmentation"
commands:
- ethtool -K ens160 tx-udp_tnl-segmentation off
- ethtool -K ens160 tx-udp_tnl-csum-segmentation off
```
This is related to a known issue in VMWare's VMXNET3 adapter, which is widely used in different virtual machine management services, including VMWare vSphere and Hyper-V.


## Enable Overlay Network

Expand Down Expand Up @@ -73,16 +84,16 @@ You will not be able to change the network overlay configurations after the clus
<Tabs>
<TabItem value="calico" label="Calico">

In the Calico pack YAML file default template, uncomment `manifests.calico.env.calicoNode.IP_AUTODETECTION_METHOD` and set its value to `interface=scbr-100`.
```yaml {11}
In the Calico pack YAML file default template, uncomment `FELIX_IPV6SUPPORT` and set its value to `scbr-100` and uncomment `manifests.calico.env.calicoNode.IP_AUTODETECTION_METHOD` and set its value to `interface=scbr-100`.
```yaml {8,11}
manifests:
calico:
...
env:
# Additional env variables for calico-node
calicoNode:
#IPV6: "autodetect"
#FELIX_IPV6SUPPORT: "true"
FELIX_IPV6SUPPORT: "scbr-100"
#CALICO_IPV6POOL_NAT_OUTGOING: "true"
#CALICO_IPV4POOL_CIDR: "192.168.0.0/16"
IP_AUTODETECTION_METHOD: "interface=scbr-100"
Expand Down
58 changes: 58 additions & 0 deletions docs/docs-content/troubleshooting/edge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
sidebar_label: "Edge"
title: "Edge"
description: "Troubleshooting steps for common Edge scenarios."
icon: ""
hide_table_of_contents: false
sidebar_position: 40
tags: ["edge", "troubleshooting"]
---

The following are common scenarios that you may encounter when using Edge.

## Scenario - Override or Reconfigure Read-only File System Stage

If you need to override or reconfigure the read-only file system, you can do so using the following steps.

## Debug Steps

<br />

1. Power on the Edge host.

2. Press the keyboard key `E` after highlighting the menu in `grubmenu`.

3. Type `rd.cos.debugrw` and press `Enter`.

![The grubmenu displays with the command rd.cos.debugrw typed in the terminal.](/troubleshooting_edge_grub-menu.png)
lennessyy marked this conversation as resolved.
Show resolved Hide resolved

4. Press `Ctrl+X` to boot the system.

5. Make the required changes to the image.

6. Reboot the system to resume the default read-only file system.

## Scenario - Cluster with Overlay Enabled Goes into Unknown State After Reboot

On slower networks, it's possible that this is due to KubeVip leader election timeouts. You can manually adjust the values of the following environment variables in the KubeVip daemon set following the steps below.

### Debug Steps

1. Ensure you can access the cluster using kubectl. For more information, refer to [Access Cluster with CLI](../clusters/cluster-management/palette-webctl.md).

2. Issue the following command:

```shell
kubectl edit ds kube-vip-ds -n kube-system
```

3. In the `env` of the KubeVip service, modify the values of the following environment variables:

```yaml
- name: vip_leaseduration
value: "30"
- name: vip_renewdeadline
value: "20"
- name: vip_retryperiod
value: "4"
```
35 changes: 0 additions & 35 deletions docs/docs-content/troubleshooting/edge.mdx

This file was deleted.

Loading