Creates a new peering rule
Creates a new peering rule
Query Parameters
Set to 'All' to perform a server-side dry run of creating this resource
Set an explicit owner for this resource
- application/json
Request Body required
The specification for the peering rule you are creating
property name*stringproperty name*stringproperty name*stringproperty name*stringproperty name*stringproperty name*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
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
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.
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.
spec
PeeringRuleSpec provides the definition for a peering rule. These are matched against one of more Network Fabric CRD and used to provision a Peer CRD which is used to connect up networks
cloudAccessConfigRef
CloudAccessConfigRef provides an optional reference to a cloudaccount which has the permission to carry out the tasks required to fulfil peering or gateway attachments
connection required
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.
providerDetails
ProviderDetails provides the cloud specific options when performing a gateway attachment
aws
AWS defines the cloud specifics for gateway options
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.
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
network
Network provides the ability to override the network which the peering is created on. By default this is the management cluster.
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.
providerDetails
ProviderDetails provides the cloud specific options when performing a gateway attachment
azure
Azure defines the cloud specifics for gateway options
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
filters required
Filters provides the ability to apply a collection of filters to whom the peering policy should apply to
allocation required
Allocation offers the ability to filter the peering policy down to a collection of workspaces only
selectors
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
matchExpressions undefined[]
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
status
PeeringRuleStatus defines the observed state of a peering setup
conditions undefined[]
lastReconcile
lastSuccess
obsoleteResources undefined[]
Responses
- 200
- 400
- 401
- 403
- 500
Contains the peering rule definition
- application/json
- Schema
- Example (from schema)
Schema
property name*stringproperty name*stringproperty name*stringproperty name*stringproperty name*stringproperty name*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
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
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.
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.
spec
PeeringRuleSpec provides the definition for a peering rule. These are matched against one of more Network Fabric CRD and used to provision a Peer CRD which is used to connect up networks
cloudAccessConfigRef
CloudAccessConfigRef provides an optional reference to a cloudaccount which has the permission to carry out the tasks required to fulfil peering or gateway attachments
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.
providerDetails
ProviderDetails provides the cloud specific options when performing a gateway attachment
aws
AWS defines the cloud specifics for gateway options
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.
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
network
Network provides the ability to override the network which the peering is created on. By default this is the management cluster.
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.
providerDetails
ProviderDetails provides the cloud specific options when performing a gateway attachment
azure
Azure defines the cloud specifics for gateway options
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
filters
Filters provides the ability to apply a collection of filters to whom the peering policy should apply to
allocation
Allocation offers the ability to filter the peering policy down to a collection of workspaces only
selectors
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
matchExpressions undefined[]
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
status
PeeringRuleStatus defines the observed state of a peering setup
conditions undefined[]
lastReconcile
lastSuccess
obsoleteResources undefined[]
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"clusterName": "string",
"creationTimestamp": "string",
"deletionGracePeriodSeconds": 0,
"deletionTimestamp": "string",
"finalizers": [
"string"
],
"generateName": "string",
"generation": 0,
"labels": {},
"managedFields": [
{
"apiVersion": "string",
"fieldsType": "string",
"fieldsV1": "string",
"manager": "string",
"operation": "string",
"subresource": "string",
"time": "string"
}
],
"name": "string",
"namespace": "string",
"ownerReferences": [
{
"apiVersion": "string",
"blockOwnerDeletion": true,
"controller": true,
"kind": "string",
"name": "string",
"uid": "string"
}
],
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"cloudAccessConfigRef": {
"name": "string",
"namespace": "string"
},
"connection": {
"gateway": {
"enableAutoApproval": true,
"identifier": "string",
"location": "string",
"providerDetails": {
"aws": {
"enableDNS": true
}
},
"routeTableSelectors": {},
"routes": [
"string"
]
},
"peering": {
"enableAutoApproval": true,
"network": {
"account": "string",
"identifier": "string",
"location": "string",
"routeTableSelectors": {},
"routes": [
"string"
]
},
"providerDetails": {
"azure": {
"enableUseRemoteGateway": true
}
},
"subnets": {}
},
"type": "string"
},
"filters": {
"allocation": {
"type": "string",
"workspaces": [
"string"
]
},
"selectors": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
}
}
},
"status": {
"cloudResourcesCreated": true,
"conditions": [
{
"detail": "string",
"lastTransitionTime": "string",
"message": "string",
"name": "string",
"negativePolarity": true,
"observedGeneration": 0,
"reason": "string",
"status": "string",
"type": "string"
}
],
"connectionID": "string",
"detail": "string",
"lastReconcile": {
"generation": 0,
"time": "string"
},
"lastSuccess": {
"generation": 0,
"time": "string"
},
"message": "string",
"obsoleteResources": [
{
"kind": "string",
"name": "string"
}
],
"status": "string",
"wayfinderVersion": "string"
}
}
Validation error of supplied parameters/body
- application/json
- Schema
- Example (from schema)
Schema
fieldErrors undefined[]
{
"code": 0,
"fieldErrors": [
{
"errCode": "string",
"field": "string",
"message": "string"
}
],
"message": "string"
}
If not authenticated
If authenticated but not authorized
A generic API error containing the cause of the error
- application/json
- Schema
- Example (from schema)
Schema
{
"code": 0,
"detail": "string",
"message": "string",
"uri": "string",
"verb": "string"
}