From 5253735bcaa20766dd3e50edad34458beda2139c Mon Sep 17 00:00:00 2001 From: Cameron Wall <75807506+cameronmwall@users.noreply.github.com> Date: Tue, 12 Mar 2024 10:22:46 -0400 Subject: [PATCH] Rewrite description (#603) * update API descriptions Signed-off-by: Cameron Wall * update API descriptions Signed-off-by: Cameron Wall * update API descriptions Signed-off-by: Cameron Wall * Doc edit Signed-off-by: Cameron Wall * Doc edit Signed-off-by: Cameron Wall * Doc edit Signed-off-by: Cameron Wall * Doc edit Signed-off-by: Cameron Wall * removed endline space Signed-off-by: Disaiah Bennett --------- Signed-off-by: Cameron Wall Signed-off-by: Disaiah Bennett Co-authored-by: Disaiah Bennett --- api/v1/multiclusterengine_types.go | 6 ++++-- ...luster.openshift.io_multiclusterengines.yaml | 10 +++++++--- docs/available-components.md | 17 +++++++++++++++++ 3 files changed, 28 insertions(+), 5 deletions(-) create mode 100644 docs/available-components.md diff --git a/api/v1/multiclusterengine_types.go b/api/v1/multiclusterengine_types.go index 9ccfc7449..d6bfdbc47 100644 --- a/api/v1/multiclusterengine_types.go +++ b/api/v1/multiclusterengine_types.go @@ -77,7 +77,7 @@ type Overrides struct { // Pull policy for the MCE images ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"` - // Provides optional configuration for components + // Provides optional configuration for components, the list of which can be found here: https://github.com/stolostron/backplane-operator/tree/main/docs/available-components.md //+operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Component Configuration",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:hidden"} // +optional Components []ComponentConfig `json:"components,omitempty"` @@ -207,7 +207,9 @@ type MultiClusterEngineCondition struct { //+kubebuilder:subresource:status //+kubebuilder:resource:scope=Cluster,shortName=mce -// MultiClusterEngine is the Schema for the multiclusterengines API +// MultiClusterEngine defines the configuration for an instance +// of a multicluster engine, a central point providing the foundational components for managing multiple Kubernetes-based clusters. The deployment of the multicluster engine components is +// determined based on the configuration that is defined in this resource. // +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.phase",description="The overall state of the MultiClusterEngine" // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" // +operator-sdk:csv:customresourcedefinitions:displayName="MultiCluster Engine" diff --git a/config/crd/bases/multicluster.openshift.io_multiclusterengines.yaml b/config/crd/bases/multicluster.openshift.io_multiclusterengines.yaml index 1c229d21f..2157bc985 100644 --- a/config/crd/bases/multicluster.openshift.io_multiclusterengines.yaml +++ b/config/crd/bases/multicluster.openshift.io_multiclusterengines.yaml @@ -28,8 +28,11 @@ spec: name: v1 schema: openAPIV3Schema: - description: MultiClusterEngine is the Schema for the multiclusterengines - API + description: MultiClusterEngine defines the configuration for an instance + of a multicluster engine, a central point providing the foundational components + for managing multiple Kubernetes-based clusters. The deployment of the multicluster + engine components is determined based on the configuration that is defined + in this resource. properties: apiVersion: description: 'APIVersion defines the versioned schema of this representation @@ -63,7 +66,8 @@ spec: description: Developer Overrides properties: components: - description: Provides optional configuration for components + description: 'Provides optional configuration for components, + the list of which can be found here: https://github.com/stolostron/backplane-operator/tree/main/docs/available-components.md' items: description: ComponentConfig provides optional configuration items for individual components diff --git a/docs/available-components.md b/docs/available-components.md new file mode 100644 index 000000000..5841cd6d8 --- /dev/null +++ b/docs/available-components.md @@ -0,0 +1,17 @@ + +# Table list of the deployed components + +| Name | Description | Enabled | +|---------------------------|----------------------------------------------------------------------------------------------------------------------|---------| +| assisted-service | Installs OpenShift with minimal infrastructure prerequisites and comprehensive pre-flight validations. | True | +| cluster-lifecycle | Provides cluster management capabilities for {ocp-short} and {product-title-short} hub clusters. | True | +| cluster-manager | Manages various cluster-related operations within the cluster environment. | True | +| cluster-proxy-addon | Automates the installation of apiserver-network-proxy on both hub and managed clusters using a reverse proxy server. | True | +| console-mce | Enables the {mce-short} console plug-in. | True | +| discovery | Discovers and identifies new clusters within the {ocm}. | True | +| hive | Provisions and performs initial configuration of {ocp-short} clusters. | True | +| hypershift | Hosts OpenShift control planes at scale with cost and time efficiency, and cross-cloud portability. | True | +| hypershift-local-hosting | Enables local hosting capabilities for within the local cluster environment. | True | +| local-cluster | Enables the import and self-management of the local hub cluster where the {mce-short} is deployed. | True | +| managedserviceaccount | Syncronizes service accounts to the managed clusters and collects tokens as secret resources back to the hub cluster.| True | +| server-foundation | Provides foundational services for server-side operations within the cluster environment. | True | \ No newline at end of file