Skip to main content

Returns a specific network fabric​

Returns a specific network fabric

Path Parameters
    workspace stringrequired

    Workspace to use

    name stringrequired

    The name of the network fabric you wish to retrieve

Responses​

Contains the network fabric definition

Schema
    apiVersion string
    kind string
    metadata

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
    • clusterName string
    creationTimestamp string
    deletionGracePeriodSeconds int64
    deletionTimestamp string
    finalizers string[]
    generateName string
    generation int64
    labels object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
    • managedFields undefined[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

    apiVersion string
    fieldsType string
    fieldsV1 string
    manager string
    operation string
    subresource string
    time string
    name string
    namespace string
    ownerReferences undefined[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    apiVersion string
    blockOwnerDeletion boolean
    controller boolean
    kind string
    name string
    uid string
    resourceVersion string
    selfLink string
    uid string
    spec

    NetworkFabricSpec defines the desired state of a network

    cloudAccessConfigRef

    CloudAccessConfigRef is a reference to the cloud access configuration that should be used to create the network.

    name string
    namespace string
    cloudResourceName string
    ipv4

    IPv4 contains the IPv4 configuration associated with the network.

    cidrBlocks undefined[]

    CIDRBlocks is a list of CIDR blocks that are associated with the network. Includes useCase so a provider or client can decide what they are used for currently only supported use cases are: - "cluster" - "pods" - "services" [AWS] Multiple IP ranges. AWS only supports a single IP range is supported on creation, but can be updated afterwards to specify additional IP ranges. [GCP] Used as metadata for cluster creation. [Azure] Multiple IP ranges.

    cidr string
    size int32
    type string
    layout

    Layout refers to the layout of the network. It controls whether the various parts - subnets, routes, etc. - are set up manually (i.e. specified in the spec) or automatically (i.e. generated by the provider).

    mode string
    privateSubnets int32
    publicSubnets int32
    location string
    plan string
    private

    Private are options related to private networking

    enabled boolean
    gateways undefined[]

    Gateways provides the options around cloud NAT gateways

    associate

    Associate is the location of the gateway

    location string
    subnet string
    ipv4

    IPv4 defines the ip allocation options of the gateway

    addresses string[]
    mode string
    nat

    NAT provides cloud agnostic settings for the NAT gateway itself

    subnets string[]
    provider string
    providerDetails

    ProviderDetails defines cloud-specific network options

    aws

    AWS is the provider specification for AWS networks

    availabilityZoneIDs string[]
    availabilityZones int32
    natGateways int32
    readOnly

    ReadOnly is the read only configuration Used when auditing the network fabric from a real VPC

    privateSubnetIDs string[]
    publicSubnetIDs string[]
    securityGroupIDs string[]
    vpcID string
    azure

    Azure is the provider specification for Azure networks

    resourceGroup string
    gcp
    type string
    routes undefined[]

    Routes is the list of routes within the network. Mode must be set to "manual" for this field to be valid. if manual, will be populated from the spec.IPv4.CIDRBlock's

    cidrBlock string
    description string
    name string
    target
    stage string
    subnets undefined[]

    Subnets is the list of subnets within the network. Mode must be set to "manual" for this field to be valid.

    description string
    ipv4

    IPv4 is the Internet Protocol (version 4) configuration for the subnet.

    cidrBlock string
    ipVersion integer
    providerDetails

    ProviderDetails is is the cloud specific configuration for the subnet.

    gcp

    GCP is the provider specification for GCP subnets

    secondaryIpRanges undefined[]
    cidrBlock string
    type string
    type string
    location string
    name string
    tags object

    Tags is a collection of tags to apply to the resources associated with the network, if applicable.

  • property name* string
    • status

    NetworkFabricStatus defines the observed state of a network

    aws

    AWS contains the AWS-specific state for the network

    accountID string
    availabilityZoneIDs string[]
    availabilityZoneNames string[]
    ipv4EgressAddresses string[]
    privateIPV4Addresses string[]
    privateSubnetIDs string[]
    publicIPV4Addresses string[]
    publicSubnetIDs string[]
    securityGroupIDs string[]
    vpcID string
    azure

    Azure contains the Azure-specific state for the network

    subnetIDs string[]
    virtualNetworkID string
    cloudResourcesCreated boolean
    conditions undefined[]
    detail string
    lastTransitionTime string
    message string
    name string
    negativePolarity boolean
    observedGeneration int64
    reason string
    status string
    type string
    detail string
    gcp

    GCP contains the GCP-specific state for the network

    gateways undefined[]

    Gateways provides a status on the gateways and any external addresses

    addresses string[]
    location string
    name string
    name string
    networkRef string
    lastReconcile
    generation int64
    time string
    lastSuccess
    generation int64
    time string
    message string
    obsoleteResources undefined[]
    kind string
    name string
    status string
    wayfinderVersion string
Loading...
Last updated on 28 Dec 2023