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

doc: update iso installation page with new cluster cidr and dhcp settings #705

Merged
merged 4 commits into from
Jan 17, 2025
Merged
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
54 changes: 54 additions & 0 deletions docs/install/harvester-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ install:
vip: 10.10.0.19
vip_hw_addr: 52:54:00:ec:0e:0b
vip_mode: dhcp
cluster_pod_cidr: 10.52.0.0/16
cluster_service_cidr: 10.53.0.0/16
cluster_dns_ip: 10.53.0.10
force_mbr: false
addons:
harvester_vm_import_controller:
Expand Down Expand Up @@ -728,6 +731,57 @@ install:
vip_hw_addr: 52:54:00:ec:0e:0b
```

### `install.cluster_pod_cidr`

**Definition**: CIDR of the Harvester pods.

Use this field to override the default pod CIDR of 10.52.0.0/16.

**Example**:

```yaml
install:
cluster_pod_cidr: 172.16.0.0/16
```

### `install.cluster_service_cidr`

**Definition**: CIDR of the Harvester services.

Use this field to override the default service CIDR of 10.53.0.0/16.

:::info important

If you change this CIDR, you must ensure that the cluster DNS IP (`install.cluster_dns`) is within this range.

:::

**Example**:

```yaml
install:
cluster_service_cidr: 172.22.0.0/16
```

### `install.cluster_dns`

**Definition**: IP of the Harvester DNS service.

Use this field to override the default DNS service IP of 10.53.0.10.

:::info important

This IP must be within the range defined by the `cluster_service_cidr` field.
ihcsim marked this conversation as resolved.
Show resolved Hide resolved

:::

**Example**:

```yaml
install:
cluster_dns: 172.16.0.10
```

### `install.webhooks`

**Definition**: Webhooks that allow you to receive notifications for certain installer-related events.
Expand Down
24 changes: 22 additions & 2 deletions docs/install/iso-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,17 +87,37 @@ The following [video](https://youtu.be/X0VIGZ_lExQ) shows a quick overview of an
For more information, see [DHCP Server Configuration](./pxe-boot-install.md#dhcp-server-configuration).
:::

1. (Optional) Configure the CIDRs for the cluster pods and services.

If you want to use the default values, leave the fields blank.

![config-cluster-cidrs.png](/img/v1.5/install/config-cluster-cidrs.png)

:::info important

The CIDR values must not overlap and must be within the private IP address range of 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16.

The DNS service IP must be within the range defined by the **Service CIDR** field.

:::

Example of a valid CIDR configuration:

- **Pod CIDR**: 172.16.0.0/16
- **Service CIDR**: 172.22.0.0/16
- **Cluster DNS IP**: 172.22.0.10

1. (Optional) Configure the `DNS Servers`. Use commas as a delimiter to add more DNS servers. Leave it blank to use the default DNS server.

![config-dns-server.png](/img/v1.2/install/config-dns-server.png)

1. Configure the virtual IP (VIP) by selecting a `VIP Mode`. This VIP is used to access the cluster or for other nodes to join the cluster.

:::note
If using DHCP to configure the IP address, you need to configure a static MAC-to-IP address mapping on your DHCP server to have a persistent virtual IP (VIP), and the VIP must be unique.
For DHCP setup with static MAC-to-IP address mappings configured, enter the MAC address in the provided field to fetch the unique persistent virtual IP (VIP). Otherwise, leave it blank.
ihcsim marked this conversation as resolved.
Show resolved Hide resolved
:::

![config-virtual-ip.png](/img/v1.2/install/config-virtual-ip.png)
![config-virtual-ip.png](/img/v1.5/install/config-virtual-ip.png)

1. Configure the `Cluster token`. This token is used for adding other nodes to the cluster.

Expand Down
Binary file added static/img/v1.5/install/config-cluster-cidrs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/v1.5/install/config-virtual-ip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading