From 4e6be6caad227c6078ebc1e4e9295026bfb703f7 Mon Sep 17 00:00:00 2001 From: Sergei Lukianov Date: Wed, 24 Jan 2024 09:24:42 -0800 Subject: [PATCH] Fix for download doc and note on 3rd party DHCP (cherry picked from commit 8fbee64d1b4fb7c373e84d079019feea23de6a3a) --- docs/getting-started/download.md | 11 +++++++++-- docs/user-guide/vpcs.md | 8 ++++++++ 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/download.md b/docs/getting-started/download.md index 7f67820..b48feda 100644 --- a/docs/getting-started/download.md +++ b/docs/getting-started/download.md @@ -16,10 +16,17 @@ docker login ghcr.io The main entry point for the software is the Hedgehog Fabricator CLI named `hhfab`. All software is published into the OCI registry [GitHub Package](https://ghcr.io) including binaries, container images, helm charts and etc. -The `hhfab` binary can be downloaded from the [GitHub Package](https://ghcr.io) using the following command: +The latest stable `hhfab` binary can be downloaded from the [GitHub Package](https://ghcr.io) using the following +command: ```bash -curl -fsSL https://i.hhdev.io/hhfab | VERSION=alpha-2 bash +curl -fsSL https://i.hhdev.io/hhfab | bash +``` + +Or you can download a specific version using the following command: + +```bash +curl -fsSL https://i.hhdev.io/hhfab | VERSION=alpha-X bash ``` The `VERSION` environment variable can be used to specify the version of the software to download. If it's not specified diff --git a/docs/user-guide/vpcs.md b/docs/user-guide/vpcs.md index 9fca7d1..246c790 100644 --- a/docs/user-guide/vpcs.md +++ b/docs/user-guide/vpcs.md @@ -32,6 +32,14 @@ spec: vlan: "1100" ``` +In case if you're using thirt-party DHCP server by configuring `spec.subnets..dhcp.relay` additional information +will be added to the DHCP packet it forwards to the DHCP server to make it possible to identify the VPC and subnet. The +information is added under the RelayAgentInfo option(82) on the DHCP packet. The relay sets two suboptions in the packet + +* VirtualSubnetSelection -- (suboption 151) is populated with the VRF which uniquely idenitifies a VPC on the Hedgehog + Fabric and will be in `VrfV` format, e.g. `VrfVvpc-1` for VPC named `vpc-1` in the Fabric API +* CircuitID -- (suboption 1) identifies the VLAN which together with VRF (VPC) name maps to a specific VPC subnet + ## VPCAttachment Represents a specific VPC subnet assignemnt to the `Connection` object which means exact server port to a VPC binding.