Oracle Cloud VMware Solution: Sddc¶

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	`Sddc`
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_sddc.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
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the SDDC.	`string`	Yes
`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 SDDC. SDDC name requirements are 1-16 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
`esxiSoftwareVersion`	The ESXi software bundle to install on the ESXi hosts in the SDDC. 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
`hcxMode`	HCX configuration of the SDDC.	`string`	Yes
`initialConfiguration`	SddcInitialConfiguration defines nested fields for Sddc.InitialConfiguration.	`object`	Yes
`isSingleHostSddc`	Indicates whether this SDDC is designated for only single ESXi host.	`boolean`	No
`sddcByolAllocationDetails`	SddcByolAllocationDetails defines nested fields for Sddc.SddcByolAllocationDetails.	`object`	No
`sshAuthorizedKeys`	One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for the default user on each ESXi host. Use a newline character to separate multiple keys. The SSH keys must be in the format required for the `authorized_keys` file	`string`	Yes
`vmwareSoftwareVersion`	The VMware software bundle to install on the ESXi hosts in the SDDC. To get a list of the available versions, use ListSupportedVmwareSoftwareVersions.	`string`	Yes

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
`clustersCount`	The number of Clusters in the SDDC.	`integer`	No
`compartmentId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the SDDC.	`string`	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 SDDC. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.	`string`	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 Cluster or ESXi host level. Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you should use UpdateSddc to update the SDDC's `vmwareSoftwareVersion` 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
`hcxFqdn`	The FQDN for HCX Manager. Example: `hcx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`	`string`	No
`hcxMode`	HCX configuration of the SDDC.	`string`	No
`hcxOnPremLicenses`	The activation licenses to use on the on-premises HCX Enterprise appliance you site pair with HCX Manager in your VMware Solution.	`list[object]`	No
`hcxPrivateIpId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is the virtual IP (VIP) for HCX Manager. For information about `PrivateIp` objects, see the Core Services API.	`string`	No
`id`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SDDC.	`string`	No
`initialConfiguration`	SddcInitialConfiguration defines nested fields for Sddc.InitialConfiguration.	`object`	No
`isHcxPendingDowngrade`	Indicates whether SDDC is pending downgrade from HCX Enterprise to HCX Advanced.	`boolean`	No
`isSingleHostSddc`	Indicates whether this SDDC is designated for only single ESXi host.	`boolean`	No
`lifecycleState`	The current state of the SDDC.	`string`	No
`nsxEdgeUplinkIpId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is the virtual IP (VIP) for the NSX Edge Uplink. Use this OCID as the route target for route table rules when setting up connectivity between the SDDC and other networks. For information about `PrivateIp` objects, see the Core Services API.	`string`	No
`nsxManagerFqdn`	The FQDN for NSX Manager. Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`	`string`	No
`nsxManagerPrivateIpId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is the virtual IP (VIP) for NSX Manager. For information about `PrivateIp` objects, see the Core Services API.	`string`	No
`nsxManagerUsername`	The SDDC includes an administrator username and initial password for NSX Manager. You can change this initial username to a different value in NSX Manager.	`string`	No
`sddcByolAllocationDetails`	SddcByolAllocationDetails defines nested fields for Sddc.SddcByolAllocationDetails.	`object`	No
`sshAuthorizedKeys`	One or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for the default user on each ESXi host. Use a newline character to separate multiple keys. The SSH keys must be in the format required for the `authorized_keys` file. This attribute is not guaranteed to reflect the public SSH keys currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the public SSH keys that Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with CreateEsxiHost. Therefore, if you upgrade the existing ESXi hosts in the SDDC to use different SSH keys, you should use UpdateSddc to update the SDDC's `sshAuthorizedKeys` with the new public keys.	`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 SDDC was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`	`string`	No
`timeHcxBillingCycleEnd`	The date and time current HCX Enterprise billing cycle ends, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`	`string`	No
`timeHcxLicenseStatusUpdated`	The date and time the SDDC's HCX on-premise license status was updated, 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 SDDC was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).	`string`	No
`vcenterFqdn`	The FQDN for vCenter. Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com`	`string`	No
`vcenterPrivateIpId`	The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PrivateIp` object that is the virtual IP (VIP) for vCenter. For information about `PrivateIp` objects, see the Core Services API.	`string`	No
`vcenterUsername`	The SDDC includes an administrator username and password for vCenter. You can change this initial username to a different value in vCenter.	`string`	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 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. Therefore, if you upgrade the existing ESXi hosts in the SDDC to use a newer version of bundled VMware software supported by the Oracle Cloud VMware Solution, you should use UpdateSddc to update the SDDC's `vmwareSoftwareVersion` with that new version.	`string`	No

Sample Manifest¶

This example is generated from the checked-in sample manifest at config/samples/ocvp_v1beta1_sddc.yaml. Replace placeholder values before applying it.

Open the rendered sample page

#
# 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 and SSH key material below before running e2e.
# Update metadata.name and spec.displayName if you want to force a fresh create instead of
# binding to an existing SDDC with the same displayName in the same compartment.
# Replace the nested initialConfiguration subnet and VLAN OCIDs with values valid for the
# target environment before running this sample.
#
apiVersion: ocvp.oracle.com/v1beta1
kind: Sddc
metadata:
  name: sddc-sample
spec:
  displayName: "sddc-sample"
  compartmentId: ocid1.compartment.oc1..exampleuniqueID
  vmwareSoftwareVersion: "7.0.0"
  hcxMode: DISABLED
  sshAuthorizedKeys: |
    ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCexampleReplaceMe user@example
  initialConfiguration:
    initialClusterConfigurations:
      - displayName: "management-cluster"
        vsphereType: MANAGEMENT
        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
          vsphereVlanId: ocid1.vlan.oc1..exampleuniqueID
          nsxEdgeUplink1VlanId: ocid1.vlan.oc1..exampleuniqueID
          nsxEdgeUplink2VlanId: ocid1.vlan.oc1..exampleuniqueID