vultr

Documentation

Overview

Copyright (C) 2021-2023, Kubefirst

This program is licensed under MIT. See the LICENSE file for more details.

Copyright (C) 2021-2023, Kubefirst

This program is licensed under MIT. See the LICENSE file for more details.

Copyright (C) 2021-2023, Kubefirst

This program is licensed under MIT. See the LICENSE file for more details.

Copyright (C) 2021-2023, Kubefirst

This program is licensed under MIT. See the LICENSE file for more details.

Copyright (C) 2021-2023, Kubefirst

This program is licensed under MIT. See the LICENSE file for more details.

Copyright (C) 2021-2023, Kubefirst

This program is licensed under MIT. See the LICENSE file for more details.

Index

• Constants
• func GetDomainApexContent(domainName string) bool
• func NewVultr(vultrAPIKey string) *govultr.Client
• type BucketCredentials
• type Configuration
  • func (c *Configuration) CreateObjectStorage(storeName string) (*govultr.ObjectStorage, error)
  • func (c *Configuration) CreateObjectStorageBucket(cr BucketCredentials, bucketName string) error
  • func (c *Configuration) DeleteBlockStorage(blockStorage []govultr.BlockStorage) error
  • func (c *Configuration) DeleteObjectStorage(storeName string) error
  • func (c *Configuration) GetDNSDomains() ([]string, error)
  • func (c *Configuration) GetDNSInfo(domainName string) (string, error)
  • func (c *Configuration) GetDNSRecords(domainName string) ([]govultr.DomainRecord, error)
  • func (c *Configuration) GetKubeconfig(clusterName string) (string, error)
  • func (c *Configuration) GetKubernetesAssociatedBlockStorage(clusterName string, returnAll bool) ([]govultr.BlockStorage, error)
  • func (c *Configuration) GetObjectStorage() ([]govultr.ObjectStorage, error)
  • func (c *Configuration) GetRegionalObjectStorageClusters() (int, error)
  • func (c *Configuration) GetRegions() ([]string, error)
  • func (c *Configuration) ListInstances() ([]string, error)
  • func (c *Configuration) TestDomainLiveness(domainName string) bool

Constants

const (
	CloudProvider = "vultr"
)

Functions

func GetDomainApexContent

func GetDomainApexContent(domainName string) bool

GetDomainApexContent determines whether or not a target domain features a host responding at zone apex

func NewVultr

func NewVultr(vultrAPIKey string) *govultr.Client

Types

type BucketCredentials

type BucketCredentials struct {
	AccessKey       string
	SecretAccessKey string
	Endpoint        string
}

type Configuration

type Configuration struct {
	Client              *govultr.Client
	Context             context.Context
	Region              string
	ObjectStorageRegion string
}

func (*Configuration) CreateObjectStorage

func (c *Configuration) CreateObjectStorage(storeName string) (*govultr.ObjectStorage, error)

CreateObjectStorage creates a Vultr object storage resource

func (*Configuration) CreateObjectStorageBucket

func (c *Configuration) CreateObjectStorageBucket(cr BucketCredentials, bucketName string) error

CreateObjectStorageBucket leverages minio to create a bucket within Vultr object storage

func (*Configuration) DeleteBlockStorage

func (c *Configuration) DeleteBlockStorage(blockStorage []govultr.BlockStorage) error

DeleteBlockStorage iterates over target volumes and deletes them

func (*Configuration) DeleteObjectStorage

func (c *Configuration) DeleteObjectStorage(storeName string) error

DeleteObjectStorage deletes a Vultr object storage resource

func (*Configuration) GetDNSDomains

func (c *Configuration) GetDNSDomains() ([]string, error)

GetDNSDomains lists all available DNS domains

func (*Configuration) GetDNSInfo

func (c *Configuration) GetDNSInfo(domainName string) (string, error)

GetDNSInfo determines whether or not a domain exists within Vultr

func (*Configuration) GetDNSRecords

func (c *Configuration) GetDNSRecords(domainName string) ([]govultr.DomainRecord, error)

GetStorageBuckets retrieves all Vultr object storage buckets

func (*Configuration) GetKubeconfig

func (c *Configuration) GetKubeconfig(clusterName string) (string, error)

func (*Configuration) GetKubernetesAssociatedBlockStorage

func (c *Configuration) GetKubernetesAssociatedBlockStorage(clusterName string, returnAll bool) ([]govultr.BlockStorage, error)

GetKubernetesAssociatedVolumes returns block storage associated with a Vultr Kubernetes cluster

func (*Configuration) GetObjectStorage

func (c *Configuration) GetObjectStorage() ([]govultr.ObjectStorage, error)

GetObjectStorage retrieves all Vultr object storage resources

func (*Configuration) GetRegionalObjectStorageClusters

func (c *Configuration) GetRegionalObjectStorageClusters() (int, error)

GetRegionalObjectStorageClusters determines if a region has object storage clusters available

func (*Configuration) GetRegions

func (c *Configuration) GetRegions() ([]string, error)

GetRegions lists all available regions

func (*Configuration) ListInstances

func (c *Configuration) ListInstances() ([]string, error)

func (*Configuration) TestDomainLiveness

func (c *Configuration) TestDomainLiveness(domainName string) bool