Oracle Cloud VMware Solution: Cluster¶
Manage OCI Oracle Cloud VMware Solution resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | ocvp |
| Resource | Cluster |
| API Version | ocvp.oracle.com/v1beta1 |
| Package | Oracle Cloud VMware Solution |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-ocvp-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/ocvp_v1beta1_cluster.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
capacityReservationId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. | string |
No |
clusterByolAllocationDetails |
ClusterByolAllocationDetails defines nested fields for Cluster.ClusterByolAllocationDetails. | object |
No |
computeAvailabilityDomain |
The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to multi-AD. |
string |
Yes |
datastoreClusterIds |
A list of datastore clusters. | list[string] |
No |
datastores |
A list of datastore info for the Cluster. This value is required only when initialHostShapeName is a standard shape. |
list[object] |
No |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
displayName |
A descriptive name for the Cluster. Cluster name requirements are 1-22 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region. Avoid entering confidential information. | string |
No |
esxiHostsCount |
The number of ESXi hosts to create in the Cluster. You can add more hosts later (see CreateEsxiHost). Note: If you later delete EXSi hosts from a production Cluster to make SDDC total host count less than 3, you are still billed for the 3 minimum recommended ESXi hosts. Also, you cannot add more VMware workloads to the Cluster until the SDDC again has at least 3 ESXi hosts. | integer |
Yes |
esxiSoftwareVersion |
The ESXi software bundle to install on the ESXi hosts in the Cluster. Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions. | string |
No |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
initialCommitment |
The billing option selected during Cluster creation. ListSupportedCommitments. | string |
No |
initialHostOcpuCount |
The initial OCPU count of the Cluster's ESXi hosts. | number |
No |
initialHostShapeName |
The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes. | string |
No |
initialVcfByolAllocationId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. | string |
No |
instanceDisplayNamePrefix |
A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix. For example, if the value is myCluster, the ESXi hosts are named myCluster-1, myCluster-2, and so on. |
string |
No |
isShieldedInstanceEnabled |
Indicates whether shielded instance is enabled for this Cluster. | boolean |
No |
networkConfiguration |
ClusterNetworkConfiguration defines nested fields for Cluster.NetworkConfiguration. | object |
Yes |
sddcId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the Cluster belongs to. | string |
Yes |
vmwareSoftwareVersion |
The VMware software bundle to install on the ESXi hosts in the Cluster. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions. | string |
No |
workloadNetworkCidr |
The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application workloads. | string |
No |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
capacityReservationId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Capacity Reservation. | string |
No |
clusterByolAllocationDetails |
ClusterByolAllocationDetails defines nested fields for Cluster.ClusterByolAllocationDetails. | object |
No |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Cluster. | string |
No |
computeAvailabilityDomain |
The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD. Example: Uocm:PHX-AD-1, multi-AD |
string |
No |
datastoreClusterIds |
A list of datastore clusters. | list[string] |
No |
datastores |
Datastores used for the Cluster. | list[object] |
No |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
displayName |
A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information. | string |
No |
esxiHostsCount |
The number of ESXi hosts in the Cluster. | integer |
No |
esxiSoftwareVersion |
In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost unless a different version is configured on the ESXi host level. Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you should use UpdateCluster to update the Cluster's esxiSoftwareVersion with that new version. |
string |
No |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cluster. | string |
No |
initialCommitment |
The billing option selected during Cluster creation. ListSupportedCommitments. | string |
No |
initialHostOcpuCount |
The initial OCPU count of the Cluster's ESXi hosts. | number |
No |
initialHostShapeName |
The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes. | string |
No |
initialVcfByolAllocationId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation. | string |
No |
instanceDisplayNamePrefix |
A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix. For example, if the value is MyCluster, the ESXi hosts are named MyCluster-1, MyCluster-2, and so on. |
string |
No |
isShieldedInstanceEnabled |
Indicates whether shielded instance is enabled at the Cluster level. | boolean |
No |
lifecycleState |
The current state of the Cluster. | string |
No |
networkConfiguration |
ClusterNetworkConfiguration defines nested fields for Cluster.NetworkConfiguration. | object |
No |
sddcId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC that the Cluster belongs to. | string |
No |
status |
- | object |
Yes |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}} |
map[string, map[string, string]] |
No |
timeCreated |
The date and time the Cluster was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z |
string |
No |
timeUpdated |
The date and time the Cluster was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). | string |
No |
upgradeLicenses |
The vSphere licenses to use when upgrading the Cluster. | list[object] |
No |
vmwareSoftwareVersion |
In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions). This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the Cluster. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this Cluster in the future with CreateEsxiHost. Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled VMware software supported by the Oracle Cloud VMware Solution, you should use UpdateCluster to update the Cluster's vmwareSoftwareVersion with that new version. |
string |
No |
vsphereType |
vSphere Cluster types. | string |
No |
vsphereUpgradeObjects |
The links to binary objects needed to upgrade vSphere. | list[object] |
No |
workloadNetworkCidr |
The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads. | string |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/ocvp_v1beta1_cluster.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
#
# Replace the OCI identifiers below before running e2e.
# Update metadata.name and spec.displayName if you want to force a fresh create instead of
# binding to an existing Cluster with the same displayName in the same SDDC.
# Replace spec.computeAvailabilityDomain with an availability domain valid for the
# target SDDC before running this sample.
#
apiVersion: ocvp.oracle.com/v1beta1
kind: Cluster
metadata:
name: cluster-sample
spec:
displayName: "cluster-sample"
sddcId: ocid1.sddc.oc1..exampleuniqueID
computeAvailabilityDomain: "Uocm:PHX-AD-1"
esxiHostsCount: 3
networkConfiguration:
provisioningSubnetId: ocid1.subnet.oc1..exampleuniqueID
vmotionVlanId: ocid1.vlan.oc1..exampleuniqueID
vsanVlanId: ocid1.vlan.oc1..exampleuniqueID
nsxVTepVlanId: ocid1.vlan.oc1..exampleuniqueID
nsxEdgeVTepVlanId: ocid1.vlan.oc1..exampleuniqueID