bean

Documentation

Index

• type AppDetail
• type ApplicationTree
• type ChartMetadata
• type HealthStatus
• type HealthStatusCode
• type HelmAppDeploymentDetail
• type HelmAppValues
• type HelmReleaseDetailRequest
• type HelmReleaseStatus
• type HibernateRequest
• type KubernetesResourcePatchRequest
• type PodMetadata
• type ReleaseStatus
• type ResourceNetworkingInfo
• type ResourceNode
• type ResourceRef
• type ResourceTreeResponse

Types

type AppDetail

type AppDetail struct {
	ApplicationStatus    *HealthStatusCode     `json:"applicationStatus"`
	ReleaseStatus        *ReleaseStatus        `json:"releaseStatus"`
	LastDeployed         time.Time             `json:"lastDeployed"`
	ChartMetadata        *ChartMetadata        `json:"chartMetadata"`
	ResourceTreeResponse *ResourceTreeResponse `json:"resourceTreeResponse"`
}

type ApplicationTree

type ApplicationTree struct {
	Nodes []*ResourceNode `json:"nodes,omitempty" protobuf:"bytes,1,rep,name=nodes"`
}

ApplicationTree holds nodes which belongs to the application

type ChartMetadata

type ChartMetadata struct {
	// The name of the chart
	ChartName string `json:"chartName"`
	// version string of the chart
	ChartVersion string `json:"chartVersion"`
	// The URL to a relevant project page, git repo, or contact person
	Home string `json:"home,omitempty"`
	// Source is the URL to the source code of this chart
	Sources []string `json:"sources,omitempty"`
	// A one-sentence description of the chart
	Description string `json:"description,omitempty"`
}

type HealthStatus

type HealthStatus struct {
	Status  HealthStatusCode `json:"status,omitempty" protobuf:"bytes,1,opt,name=status"`
	Message string           `json:"message,omitempty" protobuf:"bytes,2,opt,name=message"`
}

type HealthStatusCode

type HealthStatusCode = string

const (
	HealthStatusUnknown     HealthStatusCode = "Unknown"
	HealthStatusProgressing HealthStatusCode = "Progressing"
	HealthStatusHealthy     HealthStatusCode = "Healthy"
	HealthStatusSuspended   HealthStatusCode = "Suspended"
	HealthStatusDegraded    HealthStatusCode = "Degraded"
	HealthStatusMissing     HealthStatusCode = "Missing"
)

type HelmAppDeploymentDetail

type HelmAppDeploymentDetail struct {
	DeployedAt    time.Time      `json:"deployedAt"`
	ChartMetadata *ChartMetadata `json:"chartMetadata"`
	// Manifest is the string representation of the rendered template.
	Manifest     string   `json:"manifest"`
	DockerImages []string `json:"dockerImages"`
	// Version is an int which represents the revision of the release.
	Version int `json:"version,omitempty"`
}

type HelmAppValues

type HelmAppValues struct {
	// Values are default config for this chart.
	DefaultValues map[string]interface{} `json:"defaultValues"`
	// ValuesOverride is the set of extra Values added to the chart.
	// These values override the default values inside of the chart.
	OverrideValues map[string]interface{} `json:"overrideValues"`
	// Merged values are merged of default and override
	MergedValues map[string]interface{} `json:"mergedValues"`
}

type HelmReleaseDetailRequest

type HelmReleaseDetailRequest struct {
	ClusterHost        string `json:"clusterHost"  validate:"required"`
	ClusterBaererToken string `json:"clusterBaererToken"  validate:"required"`
	Namespace          string `json:"namespace"  validate:"required"`
	ReleaseName        string `json:"releaseName"  validate:"required"`
}

type HelmReleaseStatus

type HelmReleaseStatus = string

const (
	// StatusUnknown indicates that a release is in an uncertain state.
	StatusUnknown HelmReleaseStatus = "unknown"
	// StatusDeployed indicates that the release has been pushed to Kubernetes.
	StatusDeployed HelmReleaseStatus = "deployed"
	// StatusUninstalled indicates that a release has been uninstalled from Kubernetes.
	StatusUninstalled HelmReleaseStatus = "uninstalled"
	// StatusSuperseded indicates that this release object is outdated and a newer one exists.
	StatusSuperseded HelmReleaseStatus = "superseded"
	// StatusFailed indicates that the release was not successfully deployed.
	StatusFailed HelmReleaseStatus = "failed"
	// StatusUninstalling indicates that a uninstall operation is underway.
	StatusUninstalling HelmReleaseStatus = "uninstalling"
	// StatusPendingInstall indicates that an install operation is underway.
	StatusPendingInstall HelmReleaseStatus = "pending-install"
	// StatusPendingUpgrade indicates that an upgrade operation is underway.
	StatusPendingUpgrade HelmReleaseStatus = "pending-upgrade"
	// StatusPendingRollback indicates that an rollback operation is underway.
	StatusPendingRollback HelmReleaseStatus = "pending-rollback"
)

Describe the status of a release NOTE: Make sure to update cmd/helm/status.go when adding or modifying any of these statuses.

type HibernateRequest

type HibernateRequest struct {
	Group     string `json:"group"  validate:"required"`
	Kind      string `json:"kind"  validate:"required"`
	Version   string `json:"version"  validate:"required"`
	Name      string `json:"name"  validate:"required"`
	Namespace string `json:"namespace" validate:"required"`
}

type KubernetesResourcePatchRequest

type KubernetesResourcePatchRequest struct {
	Name                 string                      `protobuf:"bytes,1,req,name=name" json:"name,omitempty"`
	Namespace            string                      `protobuf:"bytes,2,req,name=namespace" json:"namespace,omitempty"`
	GroupVersionResource schema.GroupVersionResource `protobuf:"bytes,3,req,name=groupVersionResource" json:"groupVersionKind,omitempty"`
	Patch                string                      `protobuf:"bytes,4,req,name=patch" json:"patch,omitempty"`
	PatchType            string                      `protobuf:"bytes,5,req,name=patchType" json:"patchType,omitempty"`
}

type PodMetadata

type PodMetadata struct {
	Name           string   `json:"name"`
	UID            string   `json:"uid"`
	Containers     []string `json:"containers"`
	InitContainers []string `json:"initContainers"`
	IsNew          bool     `json:"isNew"`
}

type ReleaseStatus

type ReleaseStatus struct {
	Status      HelmReleaseStatus `json:"status"`
	Message     string            `json:"message"`
	Description string            `json:"description"`
}

type ResourceNetworkingInfo

type ResourceNetworkingInfo struct {
	Labels map[string]string `json:"labels,omitempty" protobuf:"bytes,3,opt,name=labels"`
}

ResourceNetworkingInfo holds networking resource related information

type ResourceNode

type ResourceNode struct {
	*ResourceRef    `json:",inline" protobuf:"bytes,1,opt,name=resourceRef"`
	ParentRefs      []*ResourceRef          `json:"parentRefs,omitempty" protobuf:"bytes,2,opt,name=parentRefs"`
	NetworkingInfo  *ResourceNetworkingInfo `json:"networkingInfo,omitempty" protobuf:"bytes,4,opt,name=networkingInfo"`
	ResourceVersion string                  `json:"resourceVersion,omitempty" protobuf:"bytes,5,opt,name=resourceVersion"`
	Health          *HealthStatus           `json:"health,omitempty" protobuf:"bytes,7,opt,name=health"`
	IsHibernated    bool                    `json:"isHibernated"`
	CanBeHibernated bool                    `json:"canBeHibernated"`
}

ResourceNode contains information about live resource and its children

type ResourceRef

type ResourceRef struct {
	Group     string                    `json:"group,omitempty" protobuf:"bytes,1,opt,name=group"`
	Version   string                    `json:"version,omitempty" protobuf:"bytes,2,opt,name=version"`
	Kind      string                    `json:"kind,omitempty" protobuf:"bytes,3,opt,name=kind"`
	Namespace string                    `json:"namespace,omitempty" protobuf:"bytes,4,opt,name=namespace"`
	Name      string                    `json:"name,omitempty" protobuf:"bytes,5,opt,name=name"`
	UID       string                    `json:"uid,omitempty" protobuf:"bytes,6,opt,name=uid"`
	Manifest  unstructured.Unstructured `json:"-"`
}

ResourceRef includes fields which unique identify resource

type ResourceTreeResponse

type ResourceTreeResponse struct {
	*ApplicationTree
	PodMetadata []*PodMetadata `json:"podMetadata"`
}