It's an automatically generated reference for the Fabricator API. You can find latest version in the Fabricator repository.
API Reference
Packages
fabricator.githedgehog.com/v1beta1
Package v1beta1 contains API Schema definitions for the fabricator v1beta1 API group
Resource Types
ComponentStatus
Underlying type: string
Appears in: - ComponentsStatus
| Field | Description |
|---|---|
| `` | |
NotFound |
|
Pending |
|
Ready |
|
Skipped |
ComponentsStatus
! WARNING: Make sure to update the IsReady method if you add or remove components
Appears in: - FabricatorStatus
| Field | Description | Default | Validation |
|---|---|---|---|
fabricatorAPI ComponentStatus |
|||
fabricatorCtrl ComponentStatus |
|||
fabricatorNodeConfig ComponentStatus |
|||
certManagerCtrl ComponentStatus |
|||
certManagerWebhook ComponentStatus |
|||
reloader ComponentStatus |
|||
zot ComponentStatus |
|||
ntp ComponentStatus |
|||
fabricAPI ComponentStatus |
|||
fabricCtrl ComponentStatus |
|||
fabricBoot ComponentStatus |
|||
fabricDHCP ComponentStatus |
|||
fabricProxy ComponentStatus |
|||
gatewayAPI ComponentStatus |
|||
gatewayCtrl ComponentStatus |
ControlConfig
Appears in: - FabConfig
| Field | Description | Default | Validation |
|---|---|---|---|
managementSubnet Prefix |
|||
controlVIP Prefix |
|||
tlsSAN string array |
|||
joinToken string |
|||
kubeClusterSubnet Prefix |
|||
kubeServiceSubnet Prefix |
|||
kubeClusterDNS Addr |
|||
dummySubnet Prefix |
|||
defaultUser ControlUser |
|||
ntpServers string array |
ControlConfigRegistryUpstream
Appears in: - RegistryConfig
| Field | Description | Default | Validation |
|---|---|---|---|
repo string |
|||
prefix string |
|||
noTLSVerify boolean |
|||
username string |
|||
password string |
ControlNode
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
fabricator.githedgehog.com/v1beta1 |
||
kind string |
ControlNode |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec ControlNodeSpec |
|||
status ControlNodeStatus |
ControlNodeBootstrap
Appears in: - ControlNodeSpec - FabNodeSpec
| Field | Description | Default | Validation |
|---|---|---|---|
disk string |
ControlNodeDummy
Appears in: - ControlNodeSpec - FabNodeSpec
| Field | Description | Default | Validation |
|---|---|---|---|
ip Prefix |
ControlNodeExternal
Appears in: - ControlNodeSpec
| Field | Description | Default | Validation |
|---|---|---|---|
ip PrefixOrDHCP |
|||
gateway Addr |
|||
dns Addr array |
|||
interface string |
ControlNodeManagement
Appears in: - ControlNodeSpec - FabNodeSpec
| Field | Description | Default | Validation |
|---|---|---|---|
ip Prefix |
|||
interface string |
ControlNodeSpec
Appears in: - ControlNode
| Field | Description | Default | Validation |
|---|---|---|---|
bootstrap ControlNodeBootstrap |
|||
management ControlNodeManagement |
|||
external ControlNodeExternal |
|||
dummy ControlNodeDummy |
ControlNodeStatus
Appears in: - ControlNode
ControlUser
Appears in: - ControlConfig
| Field | Description | Default | Validation |
|---|---|---|---|
password string |
|||
authorizedKeys string array |
FabConfig
Appears in: - FabricatorSpec
| Field | Description | Default | Validation |
|---|---|---|---|
control ControlConfig |
|||
registry RegistryConfig |
|||
fabric FabricConfig |
|||
gateway GatewayConfig |
FabNode
FabNode is the Schema for the nodes API.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
fabricator.githedgehog.com/v1beta1 |
||
kind string |
FabNode |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec FabNodeSpec |
|||
status FabNodeStatus |
FabNodeRole
Underlying type: string
Appears in: - FabNodeSpec
| Field | Description |
|---|---|
gateway |
FabNodeSpec
FabNodeSpec defines the desired state of FabNode.
Appears in: - FabNode
| Field | Description | Default | Validation |
|---|---|---|---|
roles FabNodeRole array |
|||
bootstrap ControlNodeBootstrap |
|||
management ControlNodeManagement |
|||
dummy ControlNodeDummy |
FabNodeStatus
FabNodeStatus defines the observed state of Node.
Appears in: - FabNode
FabOverrides
Appears in: - FabricatorSpec
| Field | Description | Default | Validation |
|---|---|---|---|
versions Versions |
FabricConfig
Appears in: - FabConfig
| Field | Description | Default | Validation |
|---|---|---|---|
mode FabricMode |
|||
managementDHCPStart Addr |
|||
managementDHCPEnd Addr |
|||
spineASN integer |
|||
leafASNStart integer |
|||
leafASNEnd integer |
|||
protocolSubnet Prefix |
|||
vtepSubnet Prefix |
|||
fabricSubnet Prefix |
|||
baseVPCCommunity string |
|||
vpcIRBVLANs VLANRange array |
|||
vpcWorkaroundVLANs VLANRange array |
|||
vpcWorkaroundSubnet Prefix |
|||
eslagMACBase string |
|||
eslagESIPrefix string |
|||
mclagSessionSubnet Prefix |
|||
defaultSwitchUsers object (keys:string, values:SwitchUser) |
|||
defaultAlloyConfig AlloyConfig |
|||
includeONIE boolean |
FabricVersions
Appears in: - Versions
| Field | Description | Default | Validation |
|---|---|---|---|
api Version |
|||
controller Version |
|||
dhcpd Version |
|||
boot Version |
|||
agent Version |
|||
ctl Version |
|||
alloy Version |
|||
proxyChart Version |
|||
proxy Version |
|||
nos object (keys:string, values:Version) |
|||
onie object (keys:string, values:Version) |
Fabricator
Fabricator defines configuration for the Fabricator controller
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
fabricator.githedgehog.com/v1beta1 |
||
kind string |
Fabricator |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec FabricatorSpec |
|||
status FabricatorStatus |
FabricatorSpec
Appears in: - Fabricator
| Field | Description | Default | Validation |
|---|---|---|---|
config FabConfig |
|||
overrides FabOverrides |
FabricatorStatus
Appears in: - Fabricator
| Field | Description | Default | Validation |
|---|---|---|---|
isBootstrap boolean |
|||
isInstall boolean |
|||
versions Versions |
|||
lastAttemptTime Time |
Time of the last attempt to apply configuration | ||
lastAttemptGen integer |
Generation of the last attempt to apply configuration | ||
lastAppliedTime Time |
Time of the last successful configuration application | ||
lastAppliedGen integer |
Generation of the last successful configuration application | ||
lastAppliedController string |
Controller version that applied the last successful configuration | ||
lastStatusCheck Time |
Time of the last status check | ||
conditions Condition array |
Conditions of the fabricator, includes readiness marker for use with kubectl wait | ||
components ComponentsStatus |
FabricatorVersions
Appears in: - Versions
| Field | Description | Default | Validation |
|---|---|---|---|
api Version |
|||
controller Version |
|||
controlISORoot Version |
|||
ctl Version |
|||
nodeConfig Version |
|||
pause Version |
|||
flatcar Version |
GatewayConfig
Appears in: - FabConfig
| Field | Description | Default | Validation |
|---|---|---|---|
enable boolean |
|||
asn integer |
GatewayVersions
Appears in: - Versions
| Field | Description | Default | Validation |
|---|---|---|---|
api Version |
|||
controller Version |
|||
agent Version |
|||
dataplane Version |
|||
frr Version |
PlatformVersions
Appears in: - Versions
| Field | Description | Default | Validation |
|---|---|---|---|
k3s Version |
|||
zot Version |
|||
certManager Version |
|||
k9s Version |
|||
toolbox Version |
|||
reloader Version |
|||
ntp Version |
|||
ntpChart Version |
RegistryConfig
Appears in: - FabConfig
| Field | Description | Default | Validation |
|---|---|---|---|
mode RegistryMode |
|||
upstream ControlConfigRegistryUpstream |
RegistryMode
Underlying type: string
Appears in: - RegistryConfig
| Field | Description |
|---|---|
airgap |
|
upstream |
SwitchUser
Appears in: - FabricConfig
| Field | Description | Default | Validation |
|---|---|---|---|
password string |
|||
role string |
|||
authorizedKeys string array |
VLABVersions
Appears in: - Versions
| Field | Description | Default | Validation |
|---|---|---|---|
onie Version |
|||
flatcar Version |
Versions
Appears in: - FabOverrides - FabricatorStatus
| Field | Description | Default | Validation |
|---|---|---|---|
platform PlatformVersions |
|||
fabricator FabricatorVersions |
|||
fabric FabricVersions |
|||
gateway GatewayVersions |
|||
vlab VLABVersions |