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.

Index

• Constants
• func GetDomainApexContent(domainName string) bool
• func NewCivo(civoToken string, region string) *civogo.Client
• type Configuration
  • func (c *Configuration) CreateStorageBucket(accessKeyID string, bucketName string, region string) (*civogo.ObjectStore, error)
  • func (c *Configuration) DeleteAccessCredentials(credentialName string) error
  • func (c *Configuration) DeleteStorageBucket(bucketName string) error
  • func (c *Configuration) GetAccessCredentials(credentialName string, region string) (*civogo.ObjectStoreCredential, error)
  • func (c *Configuration) GetDNSDomains() ([]string, error)
  • func (c *Configuration) GetDNSInfo(domainName string) (string, error)
  • func (c *Configuration) GetKubeconfig(clusterName string) (string, error)
  • func (c *Configuration) GetRegions() ([]string, error)
  • func (c *Configuration) ListInstanceSizes() ([]string, error)
  • func (c *Configuration) TestDomainLiveness(domainName, domainID string) bool

Constants

const (
	CloudProvider = "civo"
)

Functions

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 Configuration

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

func (*Configuration) CreateStorageBucket

func (c *Configuration) CreateStorageBucket(accessKeyID string, bucketName string, region string) (*civogo.ObjectStore, error)

CreateStorageBucket creates an object storage bucket

func (*Configuration) DeleteAccessCredentials

func (c *Configuration) DeleteAccessCredentials(credentialName string) error

DeleteAccessCredentials deletes object store credentials

func (*Configuration) DeleteStorageBucket

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

DeleteStorageBucket deletes an object storage bucket

func (*Configuration) GetAccessCredentials

func (c *Configuration) 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 (*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 try to reach the provided domain

func (*Configuration) GetKubeconfig

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

func (*Configuration) GetRegions

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

GetRegions lists all available regions

func (*Configuration) ListInstanceSizes

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

func (*Configuration) TestDomainLiveness

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

TestDomainLiveness checks Civo DNS for the liveness test record