Skip to main content

Returns all the available peerings​

Returns all the available peerings

Path Parameters
    workspace stringrequired

    Workspace to use

Query Parameters
    owner string

    List peerings owned by specified owner

Responses​

A list of peerings

Schema
    apiVersion string
    items undefined[]
    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

    PeeringSpec defines the definition for the peering connection resource

    cloudAccessConfigRef

    CloudAccessConfigRef provides an optional reference to a cloud access config which details the permission to carry out the tasks required to fulfil peering or gateway attachments

    name string
    namespace string
    connection

    Connection provides the policy details around how the peering should be achieved

    gateway

    Geteway provides the configuration for working with gateways and peering connections via a network backbone such as Transit Gateway.

    enableAutoApproval boolean
    identifier string
    location string
    providerDetails

    ProviderDetails provides the cloud specific options when performing a gateway attachment

    aws

    AWS defines the cloud specifics for gateway options

    enableDNS boolean
    routeTableSelectors object

    RouteTableSelectors is required when enableAutoApproval is enabled. The field provides a collection of cloud tags which is used to filter on which routing tables in the external network need updating to include the source network routes.

  • property name* string
    • routes string[]
    peering

    Peering provides the configuration for direct peering between two networks. By default the peering assumes the management network, though this can be overridden if required

    enableAutoApproval boolean
    network

    Network provides the ability to override the network which the peering is created on. By default this is the management cluster.

    account string
    identifier string
    location string
    routeTableSelectors object

    RouteTableSelectors is required when enableAutoApproval is enabled. The field provides a collection of cloud tags which is used to filter on which routing tables in the external network need updating to include the source network routes. Note, this field is not required for GCP or Azure as the route propagation is performed automatically for you.

  • property name* string
    • routes string[]
    providerDetails

    ProviderDetails provides the cloud specific options when performing a gateway attachment

    azure

    Azure defines the cloud specifics for gateway options

    enableUseRemoteGateway boolean
    subnets object

    Subnets provides a means to filter which on the subnets you want to push down the peering. By default we assume all the subnets attached to the virtual network should be routed down the peer

  • property name* string
    • type string
    networkRef

    NetworkRef is the network which we are creating a connection from

    group string
    kind string
    name string
    namespace string
    version string
    status

    PeeringStatus defines the observed state of a peering setup

    cloudResourcesCreated boolean
    conditions undefined[]
    detail string
    lastTransitionTime string
    message string
    name string
    negativePolarity boolean
    observedGeneration int64
    reason string
    status string
    type string
    detail string
    lastReconcile
    generation int64
    time string
    lastSuccess
    generation int64
    time string
    message string
    obsoleteResources undefined[]
    kind string
    name string
    peeringID string
    status string
    wayfinderVersion string
    kind string
    metadata

    ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

    continue string
    remainingItemCount int64
    resourceVersion string
    selfLink string
Loading...
Last updated on 28 Dec 2023