Rewrite description (#603)

* update API descriptions Signed-off-by: Cameron Wall <[email protected]> * update API descriptions Signed-off-by: Cameron Wall <[email protected]> * update API descriptions Signed-off-by: Cameron Wall <[email protected]> * Doc edit Signed-off-by: Cameron Wall <[email protected]> * Doc edit Signed-off-by: Cameron Wall <[email protected]> * Doc edit Signed-off-by: Cameron Wall <[email protected]> * Doc edit Signed-off-by: Cameron Wall <[email protected]> * removed endline space Signed-off-by: Disaiah Bennett <[email protected]> --------- Signed-off-by: Cameron Wall <[email protected]> Signed-off-by: Disaiah Bennett <[email protected]> Co-authored-by: Disaiah Bennett <[email protected]>
stolostron · Mar 12, 2024 · 5253735 · 5253735
1 parent 9149799
commit 5253735
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 5 deletions.
diff --git 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
@@ -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
@@ -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    |