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.

Sign up for GitHub

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 fixes #49

Merged
merged 3 commits into from
Dec 2, 2024
+29 −22
Merged

Doc fixes #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76e6a2f
fix typo in user guide
pau-hedgehog Nov 26, 2024
be6ecbe
place hhfab introduction earlier
pau-hedgehog Nov 26, 2024
d80cdd9
remove hhfctl references
pau-hedgehog Nov 26, 2024
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: 10 additions & 9 deletions docs/reference/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
26 changes: 16 additions & 10 deletions docs/user-guide/external.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/shrink-expand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/vlab/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down