k3d

package
v0.136.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 30, 2026 License: MIT Imports: 24 Imported by: 0

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.

Index

Constants

View Source 
const (
	ArgocdPortForwardURL = "http://localhost:8080"
	CloudProvider        = "k3d"
	DomainName           = "kubefirst.dev"
	GithubHost           = "github.com"
	GitlabHost           = "gitlab.com"
	K3dVersion           = "v5.8.3"
	KubectlVersion       = "v1.25.7"
	LocalhostARCH        = runtime.GOARCH
	LocalhostOS          = runtime.GOOS
	MkCertVersion        = "v1.4.4"
	TerraformVersion     = "1.3.8"
	VaultPortForwardURL  = "http://localhost:8200"
)

Variables

View Source 
var (
	ArgocdURL              = fmt.Sprintf("https://argocd.%s", DomainName)
	ArgoWorkflowsURL       = fmt.Sprintf("https://argo.%s", DomainName)
	AtlantisURL            = fmt.Sprintf("https://atlantis.%s", DomainName)
	ChartMuseumURL         = fmt.Sprintf("https://chartmuseum.%s", DomainName)
	KubefirstConsoleURL    = fmt.Sprintf("https://kubefirst.%s", DomainName)
	MetaphorDevelopmentURL = fmt.Sprintf("https://metaphor-devlopment.%s", DomainName)
	MetaphorStagingURL     = fmt.Sprintf("https://metaphor-staging.%s", DomainName)
	MetaphorProductionURL  = fmt.Sprintf("https://metaphor-production.%s", DomainName)
	VaultURL               = fmt.Sprintf("https://vault.%s", DomainName)
)

Functions

func AddK3DSecrets 

func AddK3DSecrets(destinationGitopsRepoURL, kbotPrivateKey, gitProvider, gitUser, kubeconfigPath, tokenValue string) error

func AdjustGitopsRepo 

func AdjustGitopsRepo(cloudProvider, clusterName, clusterType, gitopsRepoDir, gitProvider string, removeAtlantis, installKubefirstPro bool) error

func AdjustMetaphorRepo 

func AdjustMetaphorRepo(destinationMetaphorRepoGitURL, gitopsRepoDir, gitProvider, k1Dir string) error

func ClusterCreate 

func ClusterCreate(clusterName string, k1Dir string, k3dClient string, kubeconfig string) error

ClusterCreate create an k3d cluster

func ClusterCreateConsoleAPI 

func ClusterCreateConsoleAPI(clusterName string, k1Dir string, k3dClient string, kubeconfig string) error

ClusterCreate create an k3d cluster for use with console and api

func DeleteK3dCluster 

func DeleteK3dCluster(clusterName, k1Dir, k3dClient string) error

DeleteK3dCluster delete a k3d cluster

func DownloadTools 

func DownloadTools(clusterName string, gitProvider string, gitOwner string, toolsDir string, gitProtocol string) error

func GenerateSingleTLSSecret 

func GenerateSingleTLSSecret(
	clientset kubernetes.Interface,
	config Config,
	app string,
	ns string,
) error

GenerateSingleTLSSecret creates a single certificate for a host for k3d

func GenerateTLSSecrets 

func GenerateTLSSecrets(clientset kubernetes.Interface, config Config) error

GenerateTLSSecrets generates default certificates for k3d

func GetGithubTerraformEnvs 

func GetGithubTerraformEnvs(config *Config, envs map[string]string) map[string]string

func GetUsersTerraformEnvs 

func GetUsersTerraformEnvs(config *Config, envs map[string]string) map[string]string

func GetVaultTerraformEnvs 

func GetVaultTerraformEnvs(config *Config, envs map[string]string) map[string]string

func PostRunPrepareGitopsRepository 

func PostRunPrepareGitopsRepository(gitopsDir string) error

func PrepareGitRepositories 

func PrepareGitRepositories(
	gitProvider string,
	clusterName string,
	clusterType string,
	destinationGitopsRepoURL string,
	gitopsDir string,
	gitopsTemplateBranch string,
	gitopsTemplateURL string,
	destinationMetaphorRepoURL string,
	k1Dir string,
	gitopsTokens *GitopsDirectoryValues,
	metaphorDir string,
	metaphorTokens *MetaphorTokenValues,
	gitProtocol string,
	removeAtlantis bool,
) error

should tokens be a *GitopsDirectoryValues? does it matter

func ResolveMinioLocal 

func ResolveMinioLocal(path string) error

ResolveMinioLocal allows resolving minio over a local port forward useful when destroying a local lucster

Types

type Config added in v0.106.0 

type Config struct {
	GithubToken string
	GitlabToken string

	DestinationGitopsRepoGitURL     string
	DestinationGitopsRepoURL        string
	DestinationMetaphorRepoURL      string
	DestinationMetaphorRepoGitURL   string
	DestinationGitopsRepoHTTPSURL   string
	DestinationMetaphorRepoHTTPSURL string
	GitopsDir                       string
	GitProvider                     string
	GitProtocol                     string
	K1Dir                           string
	K3dClient                       string
	Kubeconfig                      string
	KubectlClient                   string
	KubefirstConfig                 string
	MetaphorDir                     string
	MkCertClient                    string
	MkCertPemDir                    string
	MkCertSSLSecretDir              string
	TerraformClient                 string
	ToolsDir                        string
}

func GetConfig 

func GetConfig(clusterName, gitProvider, gitOwner, gitProtocol string) (*Config, error)

GetConfig - load default values from kubefirst installer

type GithubTerraformEnvs 

type GithubTerraformEnvs struct {
	GithubToken           string
	GithubOwner           string
	AtlantisWebhookSecret string
	KbotSSHPublicKey      string
	AwsAccessKeyID        string
	AwsSecretAccessKey    string
}

type GitopsDirectoryValues 

type GitopsDirectoryValues struct {
	GithubOwner                   string
	GithubUser                    string
	GitlabOwner                   string
	GitlabOwnerGroupID            int
	GitlabUser                    string
	GitopsRepoGitURL              string
	GitopsRepoHTTPSURL            string
	DomainName                    string
	AtlantisAllowList             string
	AlertsEmail                   string
	ClusterName                   string
	ClusterType                   string
	GithubHost                    string
	GitlabHost                    string
	ArgoWorkflowsIngressURL       string
	VaultIngressURL               string
	ArgocdIngressURL              string
	AtlantisIngressURL            string
	MetaphorDevelopmentIngressURL string
	MetaphorStagingIngressURL     string
	MetaphorProductionIngressURL  string
	GitopsRepoURL                 string
	KubefirstVersion              string
	KubefirstTeam                 string
	UseTelemetry                  string
	GitProvider                   string
	CloudProvider                 string
	ClusterID                     string
	KubeconfigPath                string
}

type MetaphorTokenValues 

type MetaphorTokenValues struct {
	ClusterName                   string
	CloudRegion                   string
	ContainerRegistryURL          string
	DomainName                    string
	MetaphorDevelopmentIngressURL string
	MetaphorStagingIngressURL     string
	MetaphorProductionIngressURL  string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.