payload

Documentation

Index

• Variables
• type Manifest
• type ManifestBundle
• type ManifestBundleStatus
• type ManifestConfigOption
• type ManifestStatus

Variables

var ManifestBundleEventDataType = types.CloudEventsDataType{
	Group:    "io.open-cluster-management.works",
	Version:  "v1alpha1",
	Resource: "manifestbundles",
}

var ManifestEventDataType = types.CloudEventsDataType{
	Group:    "io.open-cluster-management.works",
	Version:  "v1alpha1",
	Resource: "manifests",
}

Types

type Manifest

type Manifest struct {
	// Manifest represents a resource to be deployed on managed cluster.
	Manifest unstructured.Unstructured `json:"manifest"`

	// DeleteOption represents deletion strategy when this manifest is deleted.
	DeleteOption *workv1.DeleteOption `json:"deleteOption,omitempty"`

	// ConfigOption represents the configuration of this manifest.
	ConfigOption *ManifestConfigOption `json:"configOption,omitempty"`
}

Manifest represents the data in a cloudevent, it contains a single manifest.

type ManifestBundle

type ManifestBundle struct {
	// Manifests represents a list of Kuberenetes resources to be deployed on a managed cluster.
	Manifests []workv1.Manifest `json:"manifests"`

	// DeleteOption represents deletion strategy when the manifests are deleted.
	DeleteOption *workv1.DeleteOption `json:"deleteOption,omitempty"`

	// ManifestConfigs represents the configurations of manifests.
	ManifestConfigs []workv1.ManifestConfigOption `json:"manifestConfigs,omitempty"`
}

ManifestBundle represents the data in a cloudevent, it contains a bundle of manifests.

type ManifestBundleStatus

type ManifestBundleStatus struct {
	// Conditions contains the different condition statuses for a ManifestBundle on managed cluster.
	// Valid condition types are:
	// 1. Applied represents the manifests in a ManifestBundle are applied successfully on a managed cluster.
	// 2. Progressing represents the manifests in a ManifestBundle are being applied on a managed cluster.
	// 3. Available represents the manifests in a ManifestBundle exist on a managed cluster.
	// 4. Degraded represents the current state of manifests in a ManifestBundle do not match the desired state for a
	//    certain period.
	// 5. Deleted represents the manifests in a ManifestBundle are deleted from a managed cluster.
	Conditions []metav1.Condition `json:"conditions"`

	// ManifestResourceStatus represents the status of each resource in manifest work deployed on managed cluster.
	ResourceStatus []workv1.ManifestCondition `json:"resourceStatus,omitempty"`
}

ManifestBundleStatus represents the data in a cloudevent, it contains the status of a ManifestBundle on a managed cluster.

type ManifestConfigOption

type ManifestConfigOption struct {
	// FeedbackRules defines what resource status field should be returned.
	// If it is not set or empty, no feedback rules will be honored.
	FeedbackRules []workv1.FeedbackRule `json:"feedbackRules,omitempty"`

	// UpdateStrategy defines the strategy to update this manifest.
	// UpdateStrategy is Update if it is not set.
	UpdateStrategy *workv1.UpdateStrategy `json:"updateStrategy,omitempty"`
}

type ManifestStatus

type ManifestStatus struct {
	// Conditions contains the different condition statuses for a SingleManifest on a managed cluster.
	// Valid condition types are:
	// 1. Applied represents the manifest of a SingleManifest is applied successfully on a managed cluster.
	// 2. Progressing represents the manifest of a SingleManifest is being applied on a managed cluster.
	// 3. Available represents the manifest of a SingleManifest exists on the managed cluster.
	// 4. Degraded represents the current state of manifest of a SingleManifest does not match the desired state for a
	//    certain period.
	// 5. Deleted represents the manifests of a SingleManifest is deleted from a managed cluster.
	Conditions []metav1.Condition `json:"conditions"`

	// Status represents the conditions of this manifest on a managed cluster.
	Status *workv1.ManifestCondition `json:"status,omitempty"`
}

ManifestStatus represents the data in a cloudevent, it contains the status of a SingleManifest on a managed cluster.