Skip to content

Commit

Permalink
Update generated API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Frostman
Frostman committed Jun 5, 2024
1 parent 4c1f05c commit d070ba6
Showing 1 changed file with 199 additions and 73 deletions.
272 changes: 199 additions & 73 deletions docs/reference/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ _Appears in:_
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `mode` _string_ | | | |
| `members` _string array_ | | | |
| `nosMembers` _string array_ | | | |
| `status` _string_ | | | |


Expand Down Expand Up @@ -1229,8 +1229,9 @@ _Appears in:_
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `subnet` _string_ | Subnet is the subnet CIDR block, such as "10.0.0.0/24", should belong to the IPv4Namespace and be unique within the namespace | | |
| `gateway` _string_ | Gateway (optional) for the subnet, if not specified, the first IP (e.g. 10.0.0.1) in the subnet is used as the gateway | | |
| `dhcp` _[VPCDHCP](#vpcdhcp)_ | DHCP is the on-demand DHCP configuration for the subnet | | |
| `vlan` _string_ | VLAN is the VLAN ID for the subnet, should belong to the VLANNamespace and be unique within the namespace | | |
| `vlan` _integer_ | VLAN is the VLAN ID for the subnet, should belong to the VLANNamespace and be unique within the namespace | | |
| `isolated` _boolean_ | Isolated is the flag to enable isolated mode for the subnet which means no access to and from the other subnets within the VPC | | |
| `restricted` _boolean_ | Restricted is the flag to enable restricted mode for the subnet which means no access between hosts within the subnet itself | | |

Expand All @@ -1243,10 +1244,10 @@ the underlay definition including Switches, Server, wiring between them and etc.

### Resource Types
- [Connection](#connection)
- [Rack](#rack)
- [Server](#server)
- [Switch](#switch)
- [SwitchGroup](#switchgroup)
- [SwitchProfile](#switchprofile)
- [VLANNamespace](#vlannamespace)


Expand Down Expand Up @@ -1684,72 +1685,6 @@ _Appears in:_
| `uuidSig` _string_ | | | |


#### Rack



Rack is the Schema for the racks API





| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `apiVersion` _string_ | `wiring.githedgehog.com/v1alpha2` | | |
| `kind` _string_ | `Rack` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
| `spec` _[RackSpec](#rackspec)_ | | | |
| `status` _[RackStatus](#rackstatus)_ | | | |


#### RackPosition



RackPosition defines the geographical position of the rack in a datacenter



_Appears in:_
- [RackSpec](#rackspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `location` _string_ | | | |
| `aisle` _string_ | | | |
| `row` _string_ | | | |


#### RackSpec



RackSpec defines the properties of a rack which we are modelling



_Appears in:_
- [Rack](#rack)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `position` _[RackPosition](#rackposition)_ | | | |


#### RackStatus



RackStatus defines the observed state of Rack



_Appears in:_
- [Rack](#rack)



#### Server


Expand Down Expand Up @@ -1860,10 +1795,6 @@ _Appears in:_
Switch is the Schema for the switches API


All switches should always have 1 labels defined: wiring.githedgehog.com/rack. It represents name of the rack it
belongs to.





Expand Down Expand Up @@ -1921,6 +1852,201 @@ _Appears in:_



#### SwitchProfile



SwitchProfile represents switch capabilities and configuration





| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `apiVersion` _string_ | `wiring.githedgehog.com/v1alpha2` | | |
| `kind` _string_ | `SwitchProfile` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
| `spec` _[SwitchProfileSpec](#switchprofilespec)_ | | | |
| `status` _[SwitchProfileStatus](#switchprofilestatus)_ | | | |


#### SwitchProfileConfig



Defines switch-specific configuration options



_Appears in:_
- [SwitchProfileSpec](#switchprofilespec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `maxPathsEBGP` _integer_ | MaxPathsIBGP defines the maximum number of IBGP paths to be configured | | |


#### SwitchProfileFeatures



Defines features supported by a specific switch which is later used for roles and Fabric API features usage validation



_Appears in:_
- [SwitchProfileSpec](#switchprofilespec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `subinterfaces` _boolean_ | Subinterfaces defines if switch supports subinterfaces | | |
| `vxlan` _boolean_ | VXLAN defines if switch supports VXLANs | | |
| `acls` _boolean_ | ACLs defines if switch supports ACLs | | |


#### SwitchProfilePort



Defines a switch port configuration
Only one of Profile or Group can be set



_Appears in:_
- [SwitchProfileSpec](#switchprofilespec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `nos` _string_ | NOSName defines how port is named in the NOS | | |
| `baseNOSName` _string_ | BaseNOSName defines the base NOS name that could be used together with the profile to generate the actual NOS name (e.g. breakouts) | | |
| `label` _string_ | Label defines the physical port label you can see on the actual switch | | |
| `group` _string_ | If port isn't directly manageable, group defines the group it belongs to, exclusive with profile | | |
| `profile` _string_ | If port is directly configurable, profile defines the profile it belongs to, exclusive with group | | |
| `management` _boolean_ | Management defines if port is a management port, it's a special case and it can't have a group or profile | | |
| `oniePortName` _string_ | OniePortName defines the ONIE port name for management ports only | | |


#### SwitchProfilePortGroup



Defines a switch port group configuration



_Appears in:_
- [SwitchProfileSpec](#switchprofilespec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `nos` _string_ | NOSName defines how group is named in the NOS | | |
| `profile` _string_ | Profile defines the possible configuration profile for the group, could only have speed profile | | |


#### SwitchProfilePortProfile



Defines a switch port profile configuration



_Appears in:_
- [SwitchProfileSpec](#switchprofilespec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `speed` _[SwitchProfilePortProfileSpeed](#switchprofileportprofilespeed)_ | Speed defines the speed configuration for the profile, exclusive with breakout | | |
| `breakout` _[SwitchProfilePortProfileBreakout](#switchprofileportprofilebreakout)_ | Breakout defines the breakout configuration for the profile, exclusive with speed | | |


#### SwitchProfilePortProfileBreakout



Defines a switch port profile breakout configuration



_Appears in:_
- [SwitchProfilePortProfile](#switchprofileportprofile)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `default` _string_ | Default defines the default breakout mode for the profile | | |
| `supported` _object (keys:string, values:[SwitchProfilePortProfileBreakoutMode](#switchprofileportprofilebreakoutmode))_ | Supported defines the supported breakout modes for the profile with the NOS name offsets | | |


#### SwitchProfilePortProfileBreakoutMode



Defines a switch port profile breakout mode configuration



_Appears in:_
- [SwitchProfilePortProfileBreakout](#switchprofileportprofilebreakout)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `offsets` _string array_ | Offsets defines the breakout NOS port name offset from the port NOS Name for each breakout mode | | |


#### SwitchProfilePortProfileSpeed



Defines a switch port profile speed configuration



_Appears in:_
- [SwitchProfilePortProfile](#switchprofileportprofile)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `default` _string_ | Default defines the default speed for the profile | | |
| `supported` _string array_ | Supported defines the supported speeds for the profile | | |


#### SwitchProfileSpec



SwitchProfileSpec defines the desired state of SwitchProfile



_Appears in:_
- [SwitchProfile](#switchprofile)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `displayName` _string_ | DisplayName defines the human-readable name of the switch | | |
| `otherNames` _string array_ | OtherNames defines alternative names for the switch | | |
| `features` _[SwitchProfileFeatures](#switchprofilefeatures)_ | Features defines the features supported by the switch | | |
| `config` _[SwitchProfileConfig](#switchprofileconfig)_ | Config defines the switch-specific configuration options | | |
| `ports` _object (keys:string, values:[SwitchProfilePort](#switchprofileport))_ | Ports defines the switch port configuration | | |
| `portGroups` _object (keys:string, values:[SwitchProfilePortGroup](#switchprofileportgroup))_ | PortGroups defines the switch port group configuration | | |
| `portProfiles` _object (keys:string, values:[SwitchProfilePortProfile](#switchprofileportprofile))_ | PortProfiles defines the switch port profile configuration | | |


#### SwitchProfileStatus



SwitchProfileStatus defines the observed state of SwitchProfile



_Appears in:_
- [SwitchProfile](#switchprofile)



#### SwitchRedundancy


Expand Down

0 comments on commit d070ba6

Please sign in to comment.