helm

Documentation

Index

• Constants
• func GetHelmReleaseName(labels map[string]string) string
• type DeploymentStatusResponse
• type EndPointURLs
• type EndpointItem
• type EndpointResponse
• type GetDeploymentResponse
• type ListDeploymentResponse

Constants

const (
	HelmReleaseNameLabelLegacy = "release"
	HelmReleaseNameLabel       = "app.kubernetes.io/instance"
)

the label Helm places on Kubernetes objects for differentiating between different instances: https://helm.sh/docs/chart_best_practices/#standard-labels

Functions

func GetHelmReleaseName

func GetHelmReleaseName(labels map[string]string) string

GetHelmReleaseName returns the helm release name placed by helm deployment Kubernetes objects it checks for label with key `HelmReleaseNameLabel`, if no such label is present than falls back the legacy label key

Types

type DeploymentStatusResponse

type DeploymentStatusResponse struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
}

DeploymentStatusResponse describes a deployment status response

type EndPointURLs

type EndPointURLs struct {
	Path        string `json:"path"`
	URL         string `json:"url"`
	ReleaseName string `json:"releaseName"`
}

EndPointURLs describes an endpoint url

type EndpointItem

type EndpointItem struct {
	Name         string           `json:"name"`
	Host         string           `json:"host"`
	Ports        map[string]int32 `json:"ports"`
	EndPointURLs []*EndPointURLs  `json:"urls"`
}

EndpointItem describes a service public endpoint

type EndpointResponse

type EndpointResponse struct {
	Endpoints []*EndpointItem `json:"endpoints"`
}

EndpointResponse describes a service public endpoints

type GetDeploymentResponse

type GetDeploymentResponse struct {
	ReleaseName  string                 `json:"releaseName"`
	Chart        string                 `json:"chart"`
	ChartName    string                 `json:"chartName"`
	ChartVersion string                 `json:"chartVersion"`
	Namespace    string                 `json:"namespace"`
	Version      int32                  `json:"version"`
	Status       string                 `json:"status"`
	Description  string                 `json:"description"`
	CreatedAt    time.Time              `json:"createdAt,omitempty"`
	Updated      time.Time              `json:"updatedAt,omitempty"`
	Notes        string                 `json:"notes"`
	Values       map[string]interface{} `json:"values"`
}

GetDeploymentResponse describes the details of a helm deployment

type ListDeploymentResponse

type ListDeploymentResponse struct {
	Name         string    `json:"releaseName"`
	Chart        string    `json:"chart"`
	ChartName    string    `json:"chartName"`
	ChartVersion string    `json:"chartVersion"`
	Version      int32     `json:"version"`
	UpdatedAt    time.Time `json:"updatedAt"`
	Status       string    `json:"status"`
	Namespace    string    `json:"namespace"`
	CreatedAt    time.Time `json:"createdAt,omitempty"`
	Supported    bool      `json:"supported"`
	WhiteListed  bool      `json:"whiteListed"`
	Rejected     bool      `json:"rejected"`
}

ListDeploymentResponse describes a deployment list response