infrastructure.dataservices.vmware.com/v1alpha1

Resource Types:

InfrastructurePolicy
IPPool
VMClass

InfrastructurePolicy

InfrastructurePolicy defines constraints on which vSphere infrastructure resources to expose for usage by data service workloads

Name	Type	Description	Required
apiVersion	string	infrastructure.dataservices.vmware.com/v1alpha1	true
kind	string	InfrastructurePolicy	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	Spec is the desired state of the InfrastructurePolicy	false
status	object	Status reports the observed state of the InfrastructurePolicy	false

InfrastructurePolicy.spec

^{^{↩ Parent}}

Spec is the desired state of the InfrastructurePolicy

Name	Type	Description	Required
enabled	boolean	Enabled specifies if the InfrastructurePolicy is available for use. Must be `true` to allow clusters to use this InfrastructurePolicy. If set to `false` existing clusters can continue to reference it but it will not be an acceptable reference for new clusters. Required. Mutable.	true
ipRanges	[]object	IPRanges are the list of IPRange configurations available for use by data service workloads. Once a cluster is using the policy IPRanges can only be added to this list, not removed. Required. Mutable.	true
placements	[]object	Placements are the list of Placement configurations available for use by the InfrastructurePolicy. Once a cluster is using the policy Placements can only be added to this list, not removed Required. Mutable.	true
storagePolicies	[]string	StoragePolicies are the list of StoragePolicyReference configurations that can be used to deploy a data service workload. Once a cluster is using the policy StoragePolicies can only be added to this list, not removed. Required. Mutable.	true
vmClasses	[]object	VMClasses are the list of VMClass references available for use by a data service workload. Once a cluster is using the policy VMClasses can only be added to this list, not removed. Required. Mutable.	true
description	string	Human-readable description of the infrastructure policy. Optional. Mutable.	false

InfrastructurePolicy.spec.ipRanges[index]

^{^{↩ Parent}}

IPRange associates an IP Pool name with the PortGroups that can use the IP Pool.

Name	Type	Description	Required
poolName	string	PoolName is the name of the IP Pool to be associated with specified PortGroups. Required. Mutable.	true
portGroups	[]object	PortGroups is the list of IPRangePortGroups associated with the specified `PoolName`. Required. Mutable.	true

InfrastructurePolicy.spec.ipRanges[index].portGroups[index]

^{^{↩ Parent}}

IPRangePortGroup specifies which datacenters' distributed port groups can be used by the data service workloads.

Name	Type	Description	Required
datacenter	string	Datacenter is the datacenter where the distributed port group is defined.	true
name	string	Name is the name of a distributed port group. Optional. Mutable.	true
moid	string	MOID is the managed object ID of a distributed port group. This must be used when NSX manages portgroups that have the same name. If the MOID is provided, then Name is ignored. Optional. Mutable.	true

InfrastructurePolicy.spec.placements[index]

^{^{↩ Parent}}

Placement is the set of resources within a single vSphere cluster

Name	Type	Description	Required
cluster	string	Cluster is the datacenter's cluster name to be used when placing the data service workload. Use the full qualified name of the cluster, relative to the datacenter. A cluster "Cluster1" inside a folder "clusters", should be declared as "clusters/Cluster1". Any slash in the name is considered a path delimiter, use the literal '%2f' if need to represent a slash in the cluster name. Required. Mutable.	true
datacenter	string	Datacenter is the vSphere Datacenter to be used when placing the data service workload. The full qualified path to the datacenter must be provided if the datacenter is placed inside a folder. Any slash in the name is considered a path delimiter, use the literal '%2f' if need to represent a slash in the datacenter name. Required. Mutable.	true
portGroups	[]string	PortGroups are the PortGroup names or MOIDs that can be used by the data service workload. Required. Mutable.	true
folder	string	Folder is the VM and Template Folder name to be used to organize VMs in the vSphere UI. Optional, VMs will be created in the root datacenter folder if not provided. Provide the full qualified path of the folder starting from the Datacenter. Any slash in the name is considered a path delimiter, use the literal '%2f' if need to represent a slash in the folder name. Optional. Mutable.	false
resourcePool	string	ResourcePool is the Cluster's resource pool to be used when placing the data service workload. If the resource pool is not provided, the whole cluster is used as the placement. Optional. Mutable.	false

InfrastructurePolicy.spec.vmClasses[index]

^{^{↩ Parent}}

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name	Type	Description	Required
name	string	Name of the referent.	false

InfrastructurePolicy.status

^{^{↩ Parent}}

Status reports the observed state of the InfrastructurePolicy

Name	Type	Description	Required
conditions	[]object	Conditions contain the list of observed conditions of the InfrastructurePolicy. The following statuses can occur. `Ready` indicates that the infrastructure policy is valid and ready to use. `Invalid` indicates that the infrastructure policy has an invalid state.	false

InfrastructurePolicy.status.conditions[index]

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. Format: date-time	true
message	string	message is a human readable message indicating details about the transition.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

IPPool

^{^{↩ Parent}}

IPPool defines the details of an IP Pool that can be used to deploy workload/database clusters

Name	Type	Description	Required
apiVersion	string	infrastructure.dataservices.vmware.com/v1alpha1	true
kind	string	IPPool	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	Spec is the desired state of an IPPool	false
status	object	Status reports the observed state of the IPPool	false

IPPool.spec

^{^{↩ Parent}}

Spec is the desired state of an IPPool

Name	Type	Description	Required
addresses	[]string	Addresses is a list of IP addresses that can be assigned. This set of addresses can be non-contiguous. Please note that if multiple IPPools are created which contain the same IP addresses no cross validation between pools is performed. Only IPs which are not in use can be removed from pools. Example `Addresses -` `- 10.0.1.10-10.0.1.100` `- 10.0.2.1` `- 10.0.2.2` Required. Mutable.	true
gateway	string	Gateway is the network gateway to use. Example `10.0.0.1` Required. Mutable.	true
prefix	integer	Prefix is the network prefix to use. It refers to the number of leading bits in the IP address. Example `24` means a subnet mask of `255.255.255.0` `22` means a subnet mask of `255.255.252.0` Required. Mutable. Minimum: 1 Maximum: 128	true

IPPool.status

^{^{↩ Parent}}

Status reports the observed state of the IPPool

Name	Type	Description	Required
conditions	[]object	Conditions contain the list of observed conditions of the IPPool. `InProgress` indicates that the ip pool is currently being created. `Ready` indicates that the ip pool is ready to be used. `Failed` indicates that the ip pool creation has failed, and it cannot be used for providing IP addresses. `Deleting` indicates that the ip pool has been requested to be deleted and the operation has not completed yet. `OverProvisioned` indicates that more IPs are being used in the IP Pool than are available to perform updates on the databases. using the IP Pool	false
ipAddresses	object	IpAddresses reports the count of total, free, used and out of range IPs in the pool.	false

IPPool.status.conditions[index]

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. Format: date-time	true
message	string	message is a human readable message indicating details about the transition.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

IPPool.status.ipAddresses

^{^{↩ Parent}}

IpAddresses reports the count of total, free, used and out of range IPs in the pool.

Name	Type	Description	Required
free	integer	Free is the count of unallocated IPs in the pool.	true
outOfRange	integer	Out of Range is the count of allocated IPs in the pool that is not contained within spec.Addresses. Legacy field	true
total	integer	Total is the total number of IPs configured for the pool.	true
used	integer	Used is the count of allocated IPs in the pool.	true

VMClass

^{^{↩ Parent}}

VMClass defines VMs which are available to host dataservice workloads

Name	Type	Description	Required
apiVersion	string	infrastructure.dataservices.vmware.com/v1alpha1	true
kind	string	VMClass	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	Spec is the desired state of the VMClass	false
status	object	Status reports the observed state of the VMClass	false

VMClass.spec

^{^{↩ Parent}}

Spec is the desired state of the VMClass

Name	Type	Description	Required
requests	object	Requests defines the amount of resources that should be allocated and reserved when this class is consumed	false

VMClass.spec.requests

^{^{↩ Parent}}

Requests defines the amount of resources that should be allocated and reserved when this class is consumed

Name	Type	Description	Required
cpu	string	CPU defines the amount of vCPU that should be used when this class is consumed. Once a cluster is created this resource will be reserved on the underlying ESXI host. It should be represented as an integer, like `2`. Kubernetes style resource capacity specifiers are not supported.	false
memory	string	Memory defines the amount of memory, in Gib that should be used when this class is consumed. Once a cluster is created this resource will be reserved on the underlying ESXI host. It should be represented as an integer, like `16`. Kubernetes style resource capacity specifiers are not supported.	false

VMClass.status

^{^{↩ Parent}}

Status reports the observed state of the VMClass

Name	Type	Description	Required
conditions	[]object	Conditions contain the list of observed conditions of the VMClass.	false

VMClass.status.conditions[index]

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. Format: date-time	true
message	string	message is a human readable message indicating details about the transition.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false