bean

Documentation

Index

• Constants
• type AppDetail
• type ApplicationTree
• type ChartMetadata
• type ClusterConfig
• type ClusterInfo
• type DesiredOrLiveManifest
• type EphemeralContainerData
• type EphemeralContainerInfo
• type EphemeralContainerStatusesInfo
• type HealthStatus
• type HealthStatusCode
• type HelmAppDeploymentDetail
• type HelmAppValues
• type HelmReleaseDetailRequest
• type HelmReleaseStatus
• type InfoItem
• type KubernetesResourcePatchRequest
• type PodMetadata
• type ReleaseStatus
• type ResourceNetworkingInfo
• type ResourceNode
• type ResourceRef
  • func (r *ResourceRef) GetGvk() schema.GroupVersionKind
• type ResourceTreeResponse

Constants

const (
	ContainersType                = "Containers"
	ContainersNamesType           = "ContainerNames"
	InitContainersNamesType       = "InitContainerNames"
	EphemeralContainersInfoType   = "EphemeralContainerInfo"
	EphemeralContainersStatusType = "EphemeralContainerStatuses"
	StatusReason                  = "Status Reason"
	Node                          = "Node"
	RestartCount                  = "Restart Count"
)

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"`
	EnvironmentDetails   *client.EnvironmentDetails `json:"environmentDetails"`
	ReleaseExists        bool                       `json:"releaseExists"`
}

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"`
	// Contains the rendered templates/NOTES.txt if available
	Notes string `json:"notes,omitempty"`
}

type ClusterConfig

type ClusterConfig struct {
	ApiServerUrl string `protobuf:"bytes,1,opt,name=apiServerUrl,proto3" json:"apiServerUrl,omitempty"`
	Token        string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	ClusterId    int32  `protobuf:"varint,3,opt,name=clusterId,proto3" json:"clusterId,omitempty"`
	ClusterName  string `protobuf:"bytes,4,opt,name=clusterName,proto3" json:"clusterName,omitempty"`
}

type ClusterInfo

type ClusterInfo struct {
	ClusterId              int                                              `json:"clusterId"`
	ClusterName            string                                           `json:"clusterName"`
	BearerToken            string                                           `json:"bearerToken"`
	ServerUrl              string                                           `json:"serverUrl"`
	InsecureSkipTLSVerify  bool                                             `json:"insecureSkipTLSVerify"`
	KeyData                string                                           `json:"-"`
	CertData               string                                           `json:"-"`
	CAData                 string                                           `json:"-"`
	RemoteConnectionConfig *remoteConnectionBean.RemoteConnectionConfigBean `json:"remoteConnectionConfig"`
}

type DesiredOrLiveManifest

type DesiredOrLiveManifest struct {
	Manifest                   *unstructured.Unstructured `json:"manifest"`
	IsLiveManifestFetchError   bool                       `json:"isLiveManifestFetchError"`
	LiveManifestFetchErrorCode int32                      `json:"liveManifestFetchErrorCode"`
}

type EphemeralContainerData

type EphemeralContainerData struct {
	Name       string `json:"name"`
	IsExternal bool   `json:"isExternal"`
}

type EphemeralContainerInfo

type EphemeralContainerInfo struct {
	Name    string
	Command []string
}

type EphemeralContainerStatusesInfo

type EphemeralContainerStatusesInfo struct {
	Name  string
	State v1.ContainerState
}

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"
	HealthStatusHibernated          HealthStatusCode = "Hibernated"
	HealthStatusPartiallyHibernated HealthStatusCode = "Partially Hibernated"
)

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 InfoItem

type InfoItem struct {
	// Name is a human readable title for this piece of information.
	Name string `json:"name,omitempty"`
	// Value is human readable content.
	Value interface{} `json:"value,omitempty"`
}

use value field as generic type InfoItem contains arbitrary, human readable information about an application

type KubernetesResourcePatchRequest

type KubernetesResourcePatchRequest struct {
	Name      string
	Namespace string
	Gvk       *schema.GroupVersionKind
	Patch     string
	PatchType string
}

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"`
	EphemeralContainers []*EphemeralContainerData `json:"ephemeralContainers"`
}

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"`
	Info            []InfoItem              `json:"info,omitempty"`
	Port            []int64                 `json:"port,omitempty"`
	CreatedAt       string                  `json:"createdAt,omitempty"`
	IsHook          bool                    `json:"isHook,omitempty"`
	HookType        string                  `json:"hookType,omitempty"`
	// UpdateRevision is used when a pod's owner is a StatefulSet for identifying if the pod is new or old
	UpdateRevision string `json:"updateRevision,omitempty"`
	// DeploymentPodHash is the podHash in deployment manifest and is used to compare replicaSet's podHash for identifying new vs old pod
	DeploymentPodHash        string `json:"deploymentPodHash,omitempty"`
	DeploymentCollisionCount *int32 `json:"deploymentCollisionCount,omitempty"`
	// RolloutCurrentPodHash is the podHash in rollout manifest and is used to compare replicaSet's podHash for identifying new vs old pod
	RolloutCurrentPodHash string `json:"rolloutCurrentPodHash,omitempty"`
}

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

func (*ResourceRef) GetGvk

func (r *ResourceRef) GetGvk() schema.GroupVersionKind

type ResourceTreeResponse

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