nutanix

Documentation

Index

• Constants
• Variables
• func CloudConfigJSON(nutanixPlatform *nutanixtypes.Platform) (string, error)
• type CloudConfig
  • func (config CloudConfig) JSON() (string, error)
• type CredentialKind
• type CredentialReference
• type PrismEndpoint
• type TopologyCategories
• type TopologyDiscovery
• type TopologyDiscoveryType
• type TopologyInfo

Constants

const (
	// PrismTopologyDiscoveryType is the DiscoveryType for Prism provider.
	PrismTopologyDiscoveryType = TopologyDiscoveryType("Prism")
	// CategoriesTopologyDiscoveryType is the DiscoveryType for Categories provider.
	CategoriesTopologyDiscoveryType = TopologyDiscoveryType("Categories")
)

Variables

var SecretKind = CredentialKind("Secret")

SecretKind a credential of type "Secret".

Functions

func CloudConfigJSON

func CloudConfigJSON(nutanixPlatform *nutanixtypes.Platform) (string, error)

CloudConfigJSON returns the json string of the created CloudConfig based on the input nutanix platform config.

Types

type CloudConfig

type CloudConfig struct {
	PrismCentral         PrismEndpoint     `json:"prismCentral"`
	TopologyDiscovery    TopologyDiscovery `json:"topologyDiscovery"`
	EnableCustomLabeling bool              `json:"enableCustomLabeling"`
}

CloudConfig is the config of Nutanix cloud provider ref: https://github.com/nutanix-cloud-native/cloud-provider-nutanix/blob/main/pkg/provider/config/config.go

func (CloudConfig) JSON

func (config CloudConfig) JSON() (string, error)

JSON generates the cloud provider json config for the Nutanix platform.

type CredentialKind

type CredentialKind string

CredentialKind type alias.

type CredentialReference

type CredentialReference struct {
	// Kind of the Nutanix credential
	Kind CredentialKind `json:"kind"`

	// Name of the credential.
	Name string `json:"name"`
	// namespace of the credential.
	Namespace string `json:"namespace"`
}

CredentialReference holds details of a credential.

type PrismEndpoint

type PrismEndpoint struct {
	// address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster)
	Address string `json:"address"`

	// port is the port number to access the Nutanix Prism Central or Element (cluster)
	Port int32 `json:"port"`

	// Pass credential information for the target Prism instance
	// +optional
	CredentialRef *CredentialReference `json:"credentialRef,omitempty"`
}

PrismEndpoint contains endpoint details for Prism provider.

type TopologyCategories

type TopologyCategories struct {
	ZoneCategory   string `json:"zoneCategory"`
	RegionCategory string `json:"regionCategory"`
}

TopologyCategories contains topology categories.

type TopologyDiscovery

type TopologyDiscovery struct {
	// Default type will be set to Prism via the newConfig function
	Type               TopologyDiscoveryType `json:"type"`
	TopologyCategories *TopologyCategories   `json:"topologyCategories"`
}

TopologyDiscovery of the cloud provider.

type TopologyDiscoveryType

type TopologyDiscoveryType string

TopologyDiscoveryType type alias.

type TopologyInfo

type TopologyInfo struct {
	Zone   string `json:"zone"`
	Region string `json:"region"`
}

TopologyInfo contains topology information.