civo

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 DownloadTools(...) error
• func GetDomainApexContent(domainName string) bool
• func NewCivo(civoToken string, region string) *civogo.Client
• type CivoConfiguration
  • func (c *CivoConfiguration) CreateStorageBucket(accessKeyId string, bucketName string, region string) (civogo.ObjectStore, error)
  • func (c *CivoConfiguration) DeleteAccessCredentials(credentialName string, region string) error
  • func (c *CivoConfiguration) DeleteStorageBucket(bucketName string) error
  • func (c *CivoConfiguration) GetAccessCredentials(credentialName string, region string) (civogo.ObjectStoreCredential, error)
  • func (c *CivoConfiguration) GetDNSDomains(region string) ([]string, error)
  • func (c *CivoConfiguration) GetDNSInfo(domainName string, region string) (string, error)
  • func (c *CivoConfiguration) GetKubeconfig(clusterName string) (string, error)
  • func (c *CivoConfiguration) GetRegions(region string) ([]string, error)
  • func (c *CivoConfiguration) ListInstanceSizes() ([]string, error)
  • func (c *CivoConfiguration) TestDomainLiveness(domainName string, domainId string, region string) bool

Constants

const (
	CloudProvider = "civo"
)

Functions

func DownloadTools

func DownloadTools(kubectlClientPath, kubectlClientVersion, localOs, localArchitecture, terraformClientVersion, toolsDirPath string) error

func GetDomainApexContent

func GetDomainApexContent(domainName string) bool

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

func NewCivo

func NewCivo(civoToken string, region string) *civogo.Client

Types

type CivoConfiguration

type CivoConfiguration struct {
	Client  *civogo.Client
	Context context.Context
}

func (*CivoConfiguration) CreateStorageBucket

func (c *CivoConfiguration) CreateStorageBucket(accessKeyId string, bucketName string, region string) (civogo.ObjectStore, error)

CreateStorageBucket creates an object storage bucket

func (*CivoConfiguration) DeleteAccessCredentials

func (c *CivoConfiguration) DeleteAccessCredentials(credentialName string, region string) error

DeleteAccessCredentials deletes object store credentials

func (*CivoConfiguration) DeleteStorageBucket

func (c *CivoConfiguration) DeleteStorageBucket(bucketName string) error

DeleteStorageBucket deletes an object storage bucket

func (*CivoConfiguration) GetAccessCredentials

func (c *CivoConfiguration) GetAccessCredentials(credentialName string, region string) (civogo.ObjectStoreCredential, error)

GetAccessCredentials creates object store access credentials if they do not exist and returns them if they do

func (*CivoConfiguration) GetDNSDomains

func (c *CivoConfiguration) GetDNSDomains(region string) ([]string, error)

GetDNSDomains lists all available DNS domains

func (*CivoConfiguration) GetDNSInfo

func (c *CivoConfiguration) GetDNSInfo(domainName string, region string) (string, error)

GetDNSInfo try to reach the provided domain

func (*CivoConfiguration) GetKubeconfig

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

func (*CivoConfiguration) GetRegions

func (c *CivoConfiguration) GetRegions(region string) ([]string, error)

GetRegions lists all available regions

func (*CivoConfiguration) ListInstanceSizes

func (c *CivoConfiguration) ListInstanceSizes() ([]string, error)

func (*CivoConfiguration) TestDomainLiveness

func (c *CivoConfiguration) TestDomainLiveness(domainName string, domainId string, region string) bool

TestDomainLiveness checks Civo DNS for the liveness test record