Used to generate the proposed network from the given spec
POST/api/v2/describe/network
Used to generate the proposed network from the given spec
Request
- application/json
Body
required
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/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.
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
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.
API version of the referent.
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
spec
ClusterNetworkPlanSpec defines the desired state of Plan
AssignableNetworks provides a list of AssignableNetworks. The plan will use these dynamic IP ranges when this is set. Do not specify any .template.ipv4.cidrBlocks[].cidr fields if this is specified. The size of the network(s) required are taken from .template.ipv4.cidrBlocks[].size.
planProviderDetails
PlanProviderDetails defines the parameters for cloud specific options specifically for a plan
aws
AWS is the provider specification for AWS networks
availabilityZoneIDsByRegion
object
AvailabilityZoneIDsByRegion is a map of region to availability zone IDs. Allows specifying which zones should be used across accounts when networks are created.
property name*
string[]
string
Summary provides a short title summary for the network plan It should describe a network in terms that are meaningful for developers: e.g. highest availability network expensive but resilient
template
required
Template are the key+value pairs describing a network configuration
cloudAccessConfigRef
CloudAccessConfigRef is a reference to the cloud access configuration that should be used to create the network.
CloudResourceName is used to identify the network object in the cloud provider [AWS] Names are not supported, so is a "Name" tag on the VPC [GCP] Name of the Network [Azure] Name of the Virtual Network (VNet)
ipv4
required
IPv4 contains the IPv4 configuration associated with the network.
cidrBlocks
undefined[]
required
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 is the cidr range in the A.B.C.D/N format
Size is the size of the CIDR range to be allocated if not specified
Type is what the cidr block is used for
layout
required
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 dictates whether the layout of the network should be set up manually or automatically. If automatic, no other fields should be specified. If manual, fields should be specified manually by the caller.
Currently, only "auto" is supported. In future, "manual" will be implemented as required.
PrivateSubnets is the number of private subnets that should be generated in the network. Mode must be set to "auto" for this field to be valid.
PublicSubnets is the number of public subnets that should be generated in the network. Mode must be set to "auto" for this field to be valid.
Location is the region the network should be created in. [AWS] Region [GCP] The Default location for subnets (as GCP actual networks are global) [Azure] Region Required if this is used for a ClusterNetwork, optional on a ClusterNetworkPlan
Plan refers to a "flavour" of network that donates the policy. For example, when .Spec.Layout.Mode="auto" and this is set to "my-network", a network values will be added automatically from the plan, with minimal input from the caller.
private
Private are options related to private networking
Enabled indicates we are expecting the predefined network layout to generate a private network.
gateways
undefined[]
Gateways provides the options around cloud NAT gateways
associate
required
Associate is the location of the gateway
Location defines the regional the gateway should reside in. This is only required for GCP where cloud gateways are regional rather than designated to an availability zone
Subnet is reference to the subnet the gateway should reside. Note the subnet must be defined in the subnets sections below. Note, GCP does not require this settings, CloudNAT is associated to a network
ipv4
required
IPv4 defines the ip allocation options of the gateway
Addresses provides a collection of external addresses which should be associated to the nat gateway, assuming the mode is static. In AWS is the an EIP which has been allocated in the correct region and account. In GCP you can define multiple external addresses which the CloudNAT will manage
Mode defines the mode of how to allocate external address or address pools to the NAT gateway
nat
NAT provides cloud agnostic settings for the NAT gateway itself
Subnet defines the subnets which should be associated and natted through the nat gateway. These must be defined in the subnets section within the cluster network spec.
Provider refers to the cloud provider.
providerDetails
ProviderDetails defines cloud-specific network options
aws
AWS is the provider specification for AWS networks
AvailabilityZoneIDs is a list of availability zone ids to use for subnets, and NAT gateways this allows specific availability zones to be specified and matched across any accounts will be populated by the AvailabilityZoneIDsByRegion if not specified directly on the plan A single region must be specified when AvailabilityZoneIDs is used.
AvailabilityZones is the number of availability zones used for the network. Must be 2 or 3 or not specified. If specified, must equal the number of privateSubnets. Each subnet (public or private) will be created in a different availability zone.
NATGateways is the number of NAT gateways to create. Must be 1 or 2 or not specified. If specified, must equal the number of privateSubnets.
azure
Azure is the provider specification for Azure networks
DNSResolverIPAddresses is a list of IPs to use for DNS resolution on the vNet it creates
ResourceGroup is the Azure resource group
ServiceEndpoints is a list of Azure private service endpoints to make available in the cluster subnet. Entries must be valid, supported service endpoints as defined by Azure - see https://learn.microsoft.com/en-us/azure/virtual-network/virtual-network-service-endpoints-overview
GCP is the provider specification for GCP networks
Type represents the cloud the ClusterNetwork belongs to
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 represents the range of destination IP addresses that this route applies to.
Description is an optional description of the route.
Name is the name of the route.
target
required
Target is the destination that the traffic bound for IP addresses within CIDRBlock range will be sent to. This target may be a gateway, network interface, or connection through which to send the destination traffic; for example, an internet gateway.
azure
NextHopIP is the IP address of the next network hop for addresses in the target range
NextHopType is the type of Azure networking device that the next hop should target (VirtualAppliance or VirtualNetworkGateway)
Stage is the name of the stage for the network. Required when used in a cluster network, optional when used in a cluster network plan.
subnets
undefined[]
Subnets is the list of subnets within the network. Mode must be set to "manual" for this field to be valid.
Description is an optional description of the subnet.
ipv4
required
IPv4 is the Internet Protocol (version 4) configuration for the subnet.
CIDRBlock is the IP address range for the subnet.
IPVersion is the Internet Protocol version of the subnet.
providerDetails
ProviderDetails is is the cloud specific configuration for the subnet.
gcp
GCP is the provider specification for GCP subnets
secondaryIpRanges
undefined[]
required
CIDRBlock is the IP address range for the subnet.
Type determines what type of secondary range ip address this is.
Type determines whether VMs launched into this subnet should have public or private IP address. If nat is specified, this must be set to "private".
Location is the zone or region associated with the subnet. [AWS] Zone [GCP] Region [Azure] Region (same as the Virtual Network)
Name is the name of the subnet.
tags
object
Tags is a collection of tags to apply to the resources associated with the network, if applicable.
status
ClusterNetworkPlanStatus defines the observed state of Plan
capacity
undefined[]
Capacity describes the capacity to build a network from this plan
Details will contain details about the capacity if there is no capacity, will include details about why
HasCapacity is true if there is capacity
Stage is the stage where there is capacity
clusters
undefined[]
Clusters describes which clusters are currently using the plan
Name is the name of a cluster
Workspace is the cluster's workspace
conditions
undefined[]
exampleNetwork
ExampleNetwork describes a cluster network that will be created from this plan
awsVPC
AWSVPC describes the next AWS VPC that would be created from this plan
CIDR is the cidr range in the A.B.C.D/N format
subnets
undefined[]
Subnets are the list of subnets that would be used by EKS
AvailabilityZone is an AWS availability zone. - In an example it is just a number but in reality it will be the actual ID
CIDR is the cidr range in the A.B.C.D/N format
NATGateway indicates whether a NAT gateway would be created for this subnet
Type is what the cidr block is used for
azureVirtualNetwork
AzureVirtualNetwork describes the next Azure Virtual Network that would be created from this plan
CIDR is the cidr range in the A.B.C.D/N format
subnets
undefined[]
Subnets are the list of subnets that would be used by AKS Only one subnet specified: - one of type azureSubnetNode, created as an Azure subnet and used by the nodes
CIDR is the cidr range in the A.B.C.D/N format
Type is what the cidr block is used for
gcpVPC
GCPVPC describes the next GCP VPC that would be created from this plan
CIDR is the cidr range in the A.B.C.D/N format
subnets
undefined[]
Subnets are the list of subnets that would be used by GKE Only two subnets are specified: - one of type gcpSubnetSecondaryService, created as a GCP secondary subnet in the GCP VPC - one of type gcpSubnetSecondaryPod, created as a GCP secondary subnet in the GCP VPC
CIDR is the cidr range in the A.B.C.D/N format
Type is what the cidr block is used for
lastReconcile
lastSuccess
obsoleteResources
undefined[]
ownedResources
cloudResources
undefined[]
wayfinderResources
undefined[]
pendingSince
Responses
- 200
- 400
- 401
- 403
- 500
Contains the network details
- application/json
- Schema
- Example (from schema)
Schema
{}
Validation error of supplied parameters/body
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
fieldErrors
undefined[]
required
{
"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"
}