Skip to content

Commit

Permalink
Fix for download doc and note on 3rd party DHCP
Browse files Browse the repository at this point in the history
(cherry picked from commit 8fbee64)
  • Loading branch information
Frostman committed Jan 24, 2024
1 parent d85430f commit 4e6be6c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/getting-started/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/user-guide/vpcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ spec:
vlan: "1100"
```
In case if you're using thirt-party DHCP server by configuring `spec.subnets.<subnet>.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<VPC-name>` 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.
Expand Down

0 comments on commit 4e6be6c

Please sign in to comment.