Skip to content

Commit

Permalink
update api version in YAML listing
Browse files Browse the repository at this point in the history
  • Loading branch information
mrbojangles3 committed Oct 23, 2024
1 parent 096c6f1 commit dc8b54f
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 35 deletions.
20 changes: 10 additions & 10 deletions docs/user-guide/connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Server connections are used to connect workload servers to switches.
Unbundled server connections are used to connect servers to a single switch using a single port.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: server-4--unbundled--s5248-02
Expand All @@ -38,7 +38,7 @@ spec:
Bundled server connections are used to connect servers to a single switch using multiple ports (port channel, LAG).
```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: server-3--bundled--s5248-01
Expand All @@ -64,7 +64,7 @@ and a Connection with type `mclag-domain` between them. MCLAG switches should al
`spec.VTEPIP`.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: server-1--mclag--s5248-01--s5248-02
Expand All @@ -89,7 +89,7 @@ should belong to the same redundancy group with type `eslag`, but contrary to th
required.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: server-1--eslag--s5248-01--s5248-02
Expand Down Expand Up @@ -117,7 +117,7 @@ the Fabric features.
A Fabric Connection is used between a specific pair of spine and leaf switches, representing all of the wires between them.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: s5232-01--fabric--s5248-01
Expand Down Expand Up @@ -146,7 +146,7 @@ configured as an MCLAG, pair which requires them to be in a single redundancy gr
type `mclag-domain` between them. MCLAG switches should also have the same `spec.ASN` and `spec.VTEPIP`.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: s5248-01--mclag-domain--s5248-02
Expand Down Expand Up @@ -179,7 +179,7 @@ VPC-Loopback connections are required in order to implement a workaround for the
attached to the same switch), which is caused by a hardware limitation of the currently supported switches.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: s5248-01--vpc-loopback
Expand All @@ -202,7 +202,7 @@ spec:
Management connections define connections to the Control Node.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: control-1--mgmt--s5248-01-front
Expand All @@ -229,7 +229,7 @@ Internet, to other networks, or to some other systems such as DHCP, NTP, LMA, or
them to specific switch ports.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: third-party-dhcp-server--static-external--s5248-04
Expand Down Expand Up @@ -265,7 +265,7 @@ Connection to external systems, such as edge/provider routers using BGP peering
communities as well as granularly controlling what gets advertised and which routes are accepted.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: s5248-03--external--5835
Expand Down
16 changes: 8 additions & 8 deletions docs/user-guide/devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ IP addresses, and more. Additionally, a `Switch` contains a reference to a `Swit
model and capabilities. More details can be found in the [Switch Profiles and Port Naming](./profiles.md) section.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Switch
metadata:
name: s5248-01
Expand Down Expand Up @@ -49,7 +49,7 @@ spec:
The `SwitchGroup` is just a marker at that point and doesn't have any configuration options.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: SwitchGroup
metadata:
name: border
Expand All @@ -75,14 +75,14 @@ switches using the `redundancy` field.
Example of switch configured for ESLAG:

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: SwitchGroup
metadata:
name: eslag-1
namespace: default
spec: {}
---
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Switch
metadata:
name: s5248-03
Expand All @@ -98,14 +98,14 @@ spec:
And example of switch configured for MCLAG:

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: SwitchGroup
metadata:
name: mclag-1
namespace: default
spec: {}
---
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Switch
metadata:
name: s5248-01
Expand All @@ -128,7 +128,7 @@ Servers include both control nodes and user's workload servers.
Control Node:

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Server
metadata:
name: control-1
Expand All @@ -140,7 +140,7 @@ spec:
Regular workload server:

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Server
metadata:
name: server-1
Expand Down
16 changes: 8 additions & 8 deletions docs/user-guide/external.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ with the following configuration:
Each `External` should be bound to some VPC IP Namespace, otherwise prefixes overlap may happen.

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: External
metadata:
name: default--5835
Expand All @@ -72,7 +72,7 @@ spec:
A `Connection` of type `external` is used to identify the switch port on Border leaf that is cabled with an Edge device.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: # specified or generated
Expand All @@ -90,7 +90,7 @@ bound to a `Connection` with type `external` and they specify an optional `vlan`
particular Edge peering.

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: ExternalAttachment
metadata:
name: #
Expand All @@ -113,7 +113,7 @@ To allow a specific VPC to have access to Edge devices, bind the VPC to a specif
an `External Peering` object.

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: ExternalPeering
metadata:
name: # Name of ExternalPeering
Expand Down Expand Up @@ -171,7 +171,7 @@ the Border Leaf `switchBorder` that has a cable connecting it to an Edge device
```

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: External
metadata:
name: HedgeEdge
Expand All @@ -190,7 +190,7 @@ Connection should be specified in the `wiring` diagram.
###
### switchBorder--external--HedgeEdge
###
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: Connection
metadata:
name: switchBorder--external--HedgeEdge
Expand All @@ -206,7 +206,7 @@ spec:
Specified in `wiring` diagram

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: ExternalAttachment
metadata:
name: switchBorder--HedgeEdge
Expand All @@ -224,7 +224,7 @@ spec:
#### ExternalPeering

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: ExternalPeering
metadata:
name: vpc-1--HedgeEdge
Expand Down
14 changes: 7 additions & 7 deletions docs/user-guide/vpcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A Virtual Private Cloud (VPC) is similar to a public cloud VPC. It provides an i
each with user-defined VLANs and optional DHCP services.

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: VPC
metadata:
name: vpc-1
Expand Down Expand Up @@ -91,7 +91,7 @@ It basically leads to the VPC being available on the specific server port(s) on
VPC could be attached to a switch that is part of the VLAN namespace used by the VPC.

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: VPCAttachment
metadata:
name: vpc-1-server-1--mclag--s5248-01--s5248-02
Expand All @@ -114,7 +114,7 @@ VPC peering is only possible between VPCs attached to the same IPv4 namespace (s
### Local VPC peering

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: VPCPeering
metadata:
name: vpc-1--vpc-2
Expand All @@ -128,7 +128,7 @@ spec:
### Remote VPC peering

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: VPCPeering
metadata:
name: vpc-1--vpc-2
Expand All @@ -146,7 +146,7 @@ It's possible to specify which specific subnets of the peering VPCs could commun
field.

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: VPCPeering
metadata:
name: vpc-1--vpc-2
Expand All @@ -169,7 +169,7 @@ An `IPv4Namespace` defines a set of (non-overlapping) IPv4 address ranges availa
Each VPC belongs to a specific IPv4 namespace. Therefore, its subnet prefixes must be from that IPv4 namespace.

```yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: IPv4Namespace
metadata:
name: default
Expand All @@ -185,7 +185,7 @@ A `VLANNamespace` defines a set of VLAN ranges available for attaching servers t
disjoint VLANNamespaces.

```yaml
apiVersion: wiring.githedgehog.com/v1alpha2
apiVersion: wiring.githedgehog.com/v1beta1
kind: VLANNamespace
metadata:
name: default
Expand Down
4 changes: 2 additions & 2 deletions docs/vlab/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ NAME SUBNETS AGE
default ["10.0.0.0/16"] 24m

core@control-1 ~ $ cat <<EOF > ipns-2.yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: IPv4Namespace
metadata:
name: ipns-2
Expand All @@ -327,7 +327,7 @@ Now we can create `vpc-3` with the same subnet as `vpc-1` (but in the different

```console
core@control-1 ~ $ cat <<EOF > vpc-3.yaml
apiVersion: vpc.githedgehog.com/v1alpha2
apiVersion: vpc.githedgehog.com/v1beta1
kind: VPC
metadata:
name: vpc-3
Expand Down

0 comments on commit dc8b54f

Please sign in to comment.