From 76e6a2f037247863c9dff85804da3c2ffa4c50af Mon Sep 17 00:00:00 2001 From: Pau Capdevila Date: Tue, 26 Nov 2024 22:19:37 +0100 Subject: [PATCH 1/3] fix typo in user guide --- docs/user-guide/shrink-expand.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/shrink-expand.md b/docs/user-guide/shrink-expand.md index 4ec0008a..e69d1208 100644 --- a/docs/user-guide/shrink-expand.md +++ b/docs/user-guide/shrink-expand.md @@ -11,7 +11,7 @@ Guide](overview.md) documentation, and the [Fabric API](../reference/api.md) ref ### Add a switch to the existing fabric In order to be added to the Hedgehog Fabric, a switch should have a corresponding `Switch` object. An example on how to define -this object is available in the [User Guild](devices.md). +this object is available in the [User Guide](devices.md). !!! note If the`Switch` will be used in `ESLAG` or `MCLAG` groups, appropriate groups should exist. Redundancy groups should From be6ecbe1021102992c60cea0d9d3d525014df698 Mon Sep 17 00:00:00 2001 From: Pau Capdevila Date: Tue, 26 Nov 2024 22:21:16 +0100 Subject: [PATCH 2/3] place hhfab introduction earlier --- docs/vlab/overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/vlab/overview.md b/docs/vlab/overview.md index 12744da9..ba67e4b0 100644 --- a/docs/vlab/overview.md +++ b/docs/vlab/overview.md @@ -9,6 +9,8 @@ boot and installation process like on real hardware. ## HHFAB +Hedgehog maintains a utility to install and configure VLAB, called `hhfab`, aka Fabricator. + The `hhfab` CLI provides a special command `vlab` to manage the virtual labs. It allows you to run sets of virtual machines to simulate the Fabric infrastructure including control node, switches, test servers and it automatically runs the installer to get Fabric up and running. @@ -84,8 +86,6 @@ curl -fsSL https://i.hhdev.io/oras | bash ### Hhfab -Hedgehog maintains a utility to install and configure VLAB, called `hhfab`. - You need a GitHub access token to download `hhfab`, please submit a ticket using the [Hedgehog Support Portal](https://support.githedgehog.com/). Once in possession of the credentials, use the provided username and token to log into the GitHub container registry: ```bash From d80cdd9f5cb8461f34c8c4ef3840239aae0dd1a1 Mon Sep 17 00:00:00 2001 From: Pau Capdevila Date: Tue, 26 Nov 2024 22:54:47 +0100 Subject: [PATCH 3/3] remove hhfctl references --- docs/reference/cli.md | 19 ++++++++++--------- docs/user-guide/external.md | 26 ++++++++++++++++---------- 2 files changed, 26 insertions(+), 19 deletions(-) diff --git a/docs/reference/cli.md b/docs/reference/cli.md index d4aafe77..743f10d1 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -12,21 +12,22 @@ be done using `kubectl`. ```bash core@control-1 ~ $ kubectl fabric NAME: - hhfctl - Hedgehog Fabric user client + kubectl fabric - Hedgehog Fabric API kubectl plugin USAGE: - hhfctl [global options] command [command options] [arguments...] + kubectl fabric [global options] command [command options] VERSION: - v0.23.0 + v0.53.1 COMMANDS: - vpc VPC commands - switch, sw, agent Switch/Agent commands - connection, conn Connection commands - switchgroup, sg SwitchGroup commands - external External commands - help, h Shows a list of commands or help for one command + vpc VPC commands + switch, sw Switch commands + connection, conn Connection commands + switchgroup, sg SwitchGroup commands + external, ext External commands + inspect, i Inspect Fabric API Objects and Primitives + help, h Shows a list of commands or help for one command GLOBAL OPTIONS: --verbose, -v verbose output (includes debug) (default: true) diff --git a/docs/user-guide/external.md b/docs/user-guide/external.md index ffed6e2c..e9743960 100644 --- a/docs/user-guide/external.md +++ b/docs/user-guide/external.md @@ -167,19 +167,25 @@ the Border Leaf `switchBorder` that has a cable connecting it to an Edge device #### External ```console -# hhfctl external create --name HedgeEdge --ipns default --in 65102:5000 --out 5000:65102 +# kubectl fabric external create --name hedgeedge --ipns default --in 65102:5000 --out 5000:65102 ``` ```yaml -apiVersion: vpc.githedgehog.com/v1beta1 -kind: External -metadata: - name: HedgeEdge - namespace: default -spec: - inboundCommunity: 65102:5000 - ipv4Namespace: default - outboundCommunity: 5000:65102 +- apiVersion: vpc.githedgehog.com/v1beta1 + kind: External + metadata: + creationTimestamp: "2024-11-26T21:24:32Z" + generation: 1 + labels: + fabric.githedgehog.com/ipv4ns: default + name: hedgeedge + namespace: default + resourceVersion: "57628" + uid: a0662988-73d0-45b3-afc0-0d009cd91ebd + spec: + inboundCommunity: 65102:5000 + ipv4Namespace: default + outboundCommunity: 5000:6510 ``` #### Connection