types

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.

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

• type AWSDomainValidateResponse
• type AWSProfilesResponse
• type CivoDomainValidationRequest
• type CivoDomainValidationResponse
• type ClusterServiceList
• type DigitalOceanDomainValidationRequest
• type DigitalOceanDomainValidationResponse
• type DomainListRequest
• type DomainListResponse
• type EnvironmentUpdateRequest
• type GitopsCatalogApp
• type GitopsCatalogAppCreateRequest
• type GitopsCatalogAppSecretKey
• type GitopsCatalogApps
• type GoogleDomainValidationRequest
• type GoogleDomainValidationResponse
• type InstanceSizesRequest
• type InstanceSizesResponse
• type JSONFailureResponse
• type JSONHealthResponse
• type JSONSuccessResponse
• type LogMessage
• type RegionListRequest
• type RegionListResponse
• type Service
• type TelemetryRequest
• type VultrDomainValidationRequest
• type VultrDomainValidationResponse
• type ZonesListRequest
• type ZonesListResponse

Types

type AWSDomainValidateResponse

type AWSDomainValidateResponse struct {
	Validated bool `json:"validated"`
}

AWSProfileResponse is the response for the /aws/profiles route

type AWSProfilesResponse

type AWSProfilesResponse struct {
	Profiles []string `json:"profiles"`
}

AWSProfileResponse is the response for the /aws/domain/validate route

type CivoDomainValidationRequest

type CivoDomainValidationRequest struct {
	CloudRegion string `json:"cloud_region"`
}

CivoDomainValidationRequest /civo/domain/validate required parameters

type CivoDomainValidationResponse

type CivoDomainValidationResponse struct {
	Validated bool `json:"validated"`
}

CivoDomainValidationResponse is the response for the /civo/domain/validate route

type ClusterServiceList

type ClusterServiceList struct {
	ClusterName string    `bson:"cluster_name" json:"cluster_name"`
	Services    []Service `bson:"services" json:"services"`
}

ClusterServiceList tracks services per cluster

type DigitalOceanDomainValidationRequest

type DigitalOceanDomainValidationRequest struct {
	CloudRegion string `json:"cloud_region"`
}

DigitalOceanDomainValidationRequest /digitalocean/domain/validate required parameters

type DigitalOceanDomainValidationResponse

type DigitalOceanDomainValidationResponse struct {
	Validated bool `json:"validated"`
}

DigitalOceanDomainValidationResponse is the response for the /digitalocean/domain/validate route

type DomainListRequest

type DomainListRequest struct {
	CloudRegion      string                    `json:"cloud_region"`
	AWSAuth          pkgtypes.AWSAuth          `json:"aws_auth,omitempty"`
	CivoAuth         pkgtypes.CivoAuth         `json:"civo_auth,omitempty"`
	DigitaloceanAuth pkgtypes.DigitaloceanAuth `json:"do_auth,omitempty"`
	VultrAuth        pkgtypes.VultrAuth        `json:"vultr_auth,omitempty"`
	CloudflareAuth   pkgtypes.CloudflareAuth   `json:"cloudflare_auth,omitempty"`
	GoogleAuth       pkgtypes.GoogleAuth       `bson:"google_auth,omitempty" json:"google_auth,omitempty"`
}

DomainListRequest

type DomainListResponse

type DomainListResponse struct {
	Domains []string `json:"domains"`
}

DomainListResponse

type EnvironmentUpdateRequest

type EnvironmentUpdateRequest struct {
	Color       string `bson:"color,omitempty" json:"color,omitempty"`
	Description string `bson:"description,omitempty" json:"description,omitempty"`
}

type GitopsCatalogApp

type GitopsCatalogApp struct {
	Name        string                      `bson:"name" json:"name" yaml:"name"`
	DisplayName string                      `bson:"display_name" json:"display_name" yaml:"displayName"`
	SecretKeys  []GitopsCatalogAppSecretKey `bson:"secret_keys" json:"secret_keys" yaml:"secretKeys"`
	ImageURL    string                      `bson:"image_url" json:"image_url" yaml:"imageUrl"`
	Description string                      `bson:"description" json:"description" yaml:"description"`
	Categories  []string                    `bson:"categories" json:"categories" yaml:"categories"`
}

GitopsCatalogApp describes a Kubefirst gitops catalog application

type GitopsCatalogAppCreateRequest

type GitopsCatalogAppCreateRequest struct {
	SecretKeys []GitopsCatalogAppSecretKey `bson:"secret_keys,omitempty" json:"secret_keys,omitempty"`
}

GitopsCatalogAppCreateRequest describes a request to create a service for a cluster based on a gitops catalog app

type GitopsCatalogAppSecretKey

type GitopsCatalogAppSecretKey struct {
	Name  string `bson:"name" json:"name" yaml:"name"`
	Label string `bson:"label,omitempty" json:"label,omitempty" yaml:"label,omitempty"`
	Value string `bson:"value,omitempty" json:"value,omitempty" yaml:"value,omitempty"`
}

GitopsCatalogAppSecretKey describes a required secret value when creating a service based on a gitops catalog app

type GitopsCatalogApps

type GitopsCatalogApps struct {
	Name string             `bson:"name" json:"name" yaml:"name"`
	Apps []GitopsCatalogApp `bson:"apps" json:"apps" yaml:"apps"`
}

GitopsCatalogApps lists all active gitops catalog app options

type GoogleDomainValidationRequest

type GoogleDomainValidationRequest struct {
	CloudRegion string `json:"cloud_region"`
}

GoogleDomainValidationRequest /google/domain/validate required parameters

type GoogleDomainValidationResponse

type GoogleDomainValidationResponse struct {
	Validated bool `json:"validated"`
}

GoogleDomainValidationResponse is the response for the /google/domain/validate route

type InstanceSizesRequest

type InstanceSizesRequest struct {
	CloudRegion      string                    `json:"cloud_region" binding:"required"`
	CloudZone        string                    `json:"cloud_zone,omitempty"`
	CivoAuth         pkgtypes.CivoAuth         `json:"civo_auth,omitempty"`
	AWSAuth          pkgtypes.AWSAuth          `json:"aws_auth,omitempty"`
	DigitaloceanAuth pkgtypes.DigitaloceanAuth `json:"do_auth,omitempty"`
	VultrAuth        pkgtypes.VultrAuth        `json:"vultr_auth,omitempty"`
	GoogleAuth       pkgtypes.GoogleAuth       `json:"google_auth,omitempty"`
}

type InstanceSizesResponse

type InstanceSizesResponse struct {
	InstanceSizes []string `json:"instance_sizes"`
}

type JSONFailureResponse

type JSONFailureResponse struct {
	Message string `json:"error" example:"err"`
}

JSONFailureResponse describes a failure message returned by the API

type JSONHealthResponse

type JSONHealthResponse struct {
	Status string `json:"status" example:"healthy"`
}

JSONHealthResponse describes a message returned by the API health endpoint

type JSONSuccessResponse

type JSONSuccessResponse struct {
	Message string `json:"message" example:"success"`
}

JSONSuccessResponse describes a success message returned by the API

type LogMessage

type LogMessage struct {
	Type    string `json:"-"`
	Message string `json:"message"`
}

type RegionListRequest

type RegionListRequest struct {
	CloudRegion      string                    `json:"cloud_region,omitempty"`
	AWSAuth          pkgtypes.AWSAuth          `json:"aws_auth,omitempty"`
	CivoAuth         pkgtypes.CivoAuth         `json:"civo_auth,omitempty"`
	DigitaloceanAuth pkgtypes.DigitaloceanAuth `json:"do_auth,omitempty"`
	VultrAuth        pkgtypes.VultrAuth        `json:"vultr_auth,omitempty"`
	GoogleAuth       pkgtypes.GoogleAuth       `bson:"google_auth,omitempty" json:"google_auth,omitempty"`
}

RegionListRequest

type RegionListResponse

type RegionListResponse struct {
	Regions []string `json:"regions"`
}

RegionListResponse

type Service

type Service struct {
	Name        string   `bson:"name" json:"name"`
	Default     bool     `bson:"default" json:"default"`
	Description string   `bson:"description" json:"description"`
	Image       string   `bson:"image" json:"image"`
	Links       []string `bson:"links" json:"links"`
	Status      string   `bson:"status" json:"status"`
}

Service defines an individual cluster service

type TelemetryRequest

type TelemetryRequest struct {
	Event string `bson:"event" json:"event"`
}

type VultrDomainValidationRequest

type VultrDomainValidationRequest struct {
	CloudRegion string `json:"cloud_region"`
}

VultrDomainValidationRequest /vultr/domain/validate required parameters

type VultrDomainValidationResponse

type VultrDomainValidationResponse struct {
	Validated bool `json:"validated"`
}

VultrDomainValidationResponse is the response for the /vultr/domain/validate route

type ZonesListRequest

type ZonesListRequest struct {
	CloudRegion string              `json:"cloud_region" binding:"required"`
	GoogleAuth  pkgtypes.GoogleAuth `json:"google_auth" binding:"required"`
}

type ZonesListResponse

type ZonesListResponse struct {
	Zones []string `json:"zones"`
}