docs(exporter): add documentation comments to app export package

Author: gergely-szabo-sap

cmd/exporter/cf/app/app.go

@@ -1,3 +1,6 @@
+// Package app implements Cloud Foundry App resource export functionality.
+// It fetches CF applications from the API, converts them to Crossplane App resources,
+// and handles filtering by organization and space.
 package app
 
 import (
@@ -32,15 +35,19 @@ func init() {
 	resources.RegisterKind(app{})
 }
 
+// res wraps a Cloud Foundry App with comment metadata for YAML export.
 type res struct {
 	*resource.App
 	*yaml.ResourceWithComment
 }
 
+// GetGUID returns the Cloud Foundry GUID of the application.
 func (r *res) GetGUID() string {
 	return r.GUID
 }
 
+// GetName returns the sanitized name of the application suitable for Kubernetes resources.
+// If sanitization fails, a warning comment is added to the resource.
 func (r *res) GetName() string {
 	name := r.Name
 	names := parsan.ParseAndSanitize(name, parsan.RFC1035LowerSubdomain)
@@ -52,18 +59,23 @@ func (r *res) GetName() string {
 	return name
 }
 
+// app implements the resources.Kind interface for CF App export.
 type app struct{}
 
 var _ resources.Kind = app{}
 
+// Param returns the configuration parameter for filtering apps during export.
 func (a app) Param() configparam.ConfigParam {
 	return param
 }
 
+// KindName returns the name of this resource kind ("app").
 func (a app) KindName() string {
 	return param.GetName()
 }
 
+// Export fetches CF applications, converts them to Crossplane resources, and emits them via the event handler.
+// It filters apps by organization/space and processes each matching application.
 func (a app) Export(ctx context.Context, cfClient *client.Client, evHandler export.EventHandler, resolveReferences bool) error {
 	apps, err := Get(ctx, cfClient)
 	if err != nil {
@@ -83,6 +95,7 @@ func (a app) Export(ctx context.Context, cfClient *client.Client, evHandler expo
 	return nil
 }
 
+// getAllNamesFn returns a function that fetches all app names for the given org/space GUIDs.
 func getAllNamesFn(ctx context.Context, cfClient *client.Client, orgGuids, spaceGuids []string) func() ([]string, error) {
 	return func() ([]string, error) {
 		resources, err := getAll(ctx, cfClient, orgGuids, spaceGuids, []string{})
@@ -97,6 +110,8 @@ func getAllNamesFn(ctx context.Context, cfClient *client.Client, orgGuids, space
 	}
 }
 
+// Get returns all CF applications matching the configured filter criteria.
+// Results are cached for subsequent calls. It prompts for app selection if none are specified.
 func Get(ctx context.Context, cfClient *client.Client) (mkcontainer.TypedContainer[*res], error) {
 	if c != nil {
 		return c, nil
@@ -143,6 +158,8 @@ func Get(ctx context.Context, cfClient *client.Client) (mkcontainer.TypedContain
 	return c, nil
 }
 
+// getAll retrieves applications from the CF API and filters them by the provided name patterns.
+// Supports regex matching for app names. If appNames is empty, matches all applications.
 func getAll(ctx context.Context, cfClient *client.Client, orgGuids, spaceGuids, appNames []string) ([]*res, error) {
 	var nameRxs []*regexp.Regexp
 

cmd/exporter/cf/app/convert.go

@@ -1,3 +1,4 @@
+// Package app implements Cloud Foundry App resource export functionality.
 package app
 
 import (
@@ -18,6 +19,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// convertDockerField converts Docker configuration from CF manifest to Crossplane DockerConfiguration.
+// Generates a Secret for Docker credentials if username is provided. Password is set to "TODO" placeholder.
 func convertDockerField(app *res, managedApp *v1alpha1.App, appManifest *operation.AppManifest, evHandler export.EventHandler) error {
 	docker := appManifest.Docker
 
@@ -51,6 +54,8 @@ func convertDockerField(app *res, managedApp *v1alpha1.App, appManifest *operati
 	return nil
 }
 
+// convertProcessesField converts CF application processes to Crossplane ProcessConfiguration.
+// Handles all process types including web and worker processes with health checks.
 func convertProcessesField(managedApp *v1alpha1.App, appManifest *operation.AppManifest) {
 	if appManifest.Processes == nil {
 		return
@@ -78,6 +83,9 @@ func convertProcessesField(managedApp *v1alpha1.App, appManifest *operation.AppM
 	}
 }
 
+// convertAppResource converts a CF application to a Crossplane App resource with manifest data.
+// Fetches the app manifest, converts Docker config and processes, and optionally resolves space references.
+// Returns a ResourceWithComment containing the converted App and any warning comments.
 func convertAppResource(ctx context.Context, cfClient *client.Client, app *res, evHandler export.EventHandler, resolveReferences bool) *yaml.ResourceWithComment {
 	slog.Debug("converting app", "name", app.Name)
 

cmd/exporter/cf/app/manifest.go

@@ -1,3 +1,4 @@
+// Package app implements Cloud Foundry App resource export functionality.
 package app
 
 import (
@@ -27,6 +28,8 @@ import (
 // 	Applications []application `json:"applications"`
 // }
 
+// getManifest fetches the application manifest from Cloud Foundry API for the given app GUID.
+// Returns the parsed manifest containing all application configurations.
 func getManifest(ctx context.Context, cfClient *client.Client, appGUID string) (*operation.Manifest, error) {
 	m := &operation.Manifest{}
 	stringManifest, err := cfClient.Manifests.Generate(ctx, appGUID)
@@ -40,6 +43,8 @@ func getManifest(ctx context.Context, cfClient *client.Client, appGUID string) (
 	return m, err
 }
 
+// getAppManifest retrieves the first application manifest from the CF API response.
+// Returns nil if no applications are found in the manifest.
 func getAppManifest(ctx context.Context, cfClient *client.Client, appGUID string) (*operation.AppManifest, error) {
 	m, err := getManifest(ctx, cfClient, appGUID)
 	if err != nil {

cmd/exporter/cf/app/secret.go

@@ -1,3 +1,4 @@
+// Package app implements Cloud Foundry App resource export functionality.
 package app
 
 import (
@@ -6,6 +7,9 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// generateDockerCredentialSecret creates a Kubernetes Secret for Docker registry credentials.
+// The password field is set to "TODO" as a placeholder since the actual password cannot be exported.
+// The secret includes a comment reminding users to manually fill in the password.
 func generateDockerCredentialSecret(name, username string) *yaml.ResourceWithComment {
 	s := &v1.Secret{
 		TypeMeta: metav1.TypeMeta{