README
¶
Cluster Lifecycle API
The cluster-lifecycle-api repository defines relevant concepts and types for Cluster Lifecycle APIs used in MCE and ACM.
Some APIs are moved from the foundation repository https://github.com/stolostron/multicloud-operators-foundation.
APIs
ManagedClusterActionis defined as a certain action job executed on a certain managed cluster to Create/Update/Delete a resource.ManagedClusterViewis defined to get a specified resource on a certain managed cluster.ManagedClusterImageRegistryis defined as a configuration to override the images of pods deployed on the managed clusters.ManagedClusterInfois the namespace-scoped definition of managedCluster, including some special infos for MCE and ACM.KluterletConfigis defined to hold the configuration of klusterlet.
How to update the APIs
- Folk the repository the dir
$GOPATH/src/github.com/stolostron/cluster-lifecycle-api. - Run
make update.
Community, discussion, contribution, and support
Check the CONTRIBUTING Doc for how to contribute to the repo.
Security Response
If you've found a security issue that you'd like to disclose confidentially please contact Red Hat's Product Security team. Details at here.
Directories
¶
| Path | Synopsis |
|---|---|
|
action
|
|
|
v1beta1
Package v1beta1 contains API Schema definitions for the action v1beta1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/action +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=action.open-cluster-management.io
|
Package v1beta1 contains API Schema definitions for the action v1beta1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/action +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=action.open-cluster-management.io |
|
client
|
|
|
action/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
action/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
action/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
action/clientset/versioned/typed/action/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
action/clientset/versioned/typed/action/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
clusterinfo/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
clusterinfo/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
clusterinfo/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
clusterinfo/clientset/versioned/typed/clusterinfo/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
clusterinfo/clientset/versioned/typed/clusterinfo/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
imageregistry/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
imageregistry/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
imageregistry/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
imageregistry/clientset/versioned/typed/imageregistry/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
imageregistry/clientset/versioned/typed/imageregistry/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
klusterletconfig/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
klusterletconfig/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
klusterletconfig/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
klusterletconfig/clientset/versioned/typed/klusterletconfig/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
klusterletconfig/clientset/versioned/typed/klusterletconfig/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
view/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
view/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
view/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
view/clientset/versioned/typed/view/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
view/clientset/versioned/typed/view/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
clusterinfo
|
|
|
v1beta1
Package v1beta1 contains API Schema definitions for the clusterinfo v1beta1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/clusterinfo +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=internal.open-cluster-management.io
|
Package v1beta1 contains API Schema definitions for the clusterinfo v1beta1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/clusterinfo +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=internal.open-cluster-management.io |
|
helpers
|
|
|
imageregistry
|
|
|
v1alpha1
Package v1alpha1 contains API Schema definitions for the imageregistry v1alpha1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/imageregistry +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=imageregistry.open-cluster-management.io
|
Package v1alpha1 contains API Schema definitions for the imageregistry v1alpha1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/imageregistry +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=imageregistry.open-cluster-management.io |
|
klusterletconfig
|
|
|
v1alpha1
Package v1alpha1 contains API Schema definitions for the klusterletconfig v1alpha1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/klusterletconfig +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=config.open-cluster-management.io
|
Package v1alpha1 contains API Schema definitions for the klusterletconfig v1alpha1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/klusterletconfig +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=config.open-cluster-management.io |
|
tools
|
|
|
genswaggertypedocs
lifted from k8s.io/kubernetes so we can add methods to types
|
lifted from k8s.io/kubernetes so we can add methods to types |
|
view
|
|
|
v1beta1
Package v1beta1 contains API Schema definitions for the view v1beta1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/view +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=view.open-cluster-management.io
|
Package v1beta1 contains API Schema definitions for the view v1beta1 API group +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/stolostron/cluster-lifecycle-api/view +k8s:defaulter-gen=TypeMeta +k8s:openapi-gen=true +kubebuilder:validation:Optional +groupName=view.open-cluster-management.io |
Click to show internal directories.
Click to hide internal directories.