composite template deprecation

Signed-off-by: Jordan Keister <[email protected]>

Author: grokspawn

docs/users/fbc_onboarding.md

@@ -56,19 +56,17 @@ $ tree operators/aqua
 operators/aqua
 ├── 0.0.1
 ...
-├── catalogs.yaml
 ├── catalog-templates
 │   ├── v4.12.yaml
 │   ├── v4.13.yaml
 │   ├── v4.14.yaml
 │   ├── v4.15.yaml
 │   └── v4.16.yaml
 ├── ci.yaml
-└── composite-config.yaml
 ```
 ... and File-based catalog in `catalogs` directory
 ```bash
-$ tree catalogs
+$ tree (repository root)/catalogs
 catalogs
 ├── v4.12
 │   └── aqua
@@ -92,20 +90,19 @@ catalogs
 Artifacts generated in the previous step need to be added to a git and submitted via pull request. The operator pipeline validates the content of the catalogs and releases changes into ocp catalogs.
 
 ```bash
-$ git add operators/aqua/{catalog-templates,catalogs.yaml,composite-config.yaml,ci.yaml}
+$ git add operators/aqua/{catalog-templates,ci.yaml}
 
-$ git add
 $ git add catalogs/{v4.12,v4.13,v4.14,v4.15,v4.16}/aqua
 
 $ git commit --signoff -m "Add FBC resources for aqua operator"
 ```
 
 ## Generating catalogs from templates
-Catalog templates are used to simplify a view of a catalog and allow easier manipulation of catalogs. The automated conversion pre-generates a basic + composite template that can be turned into full FBC using the following command:
+Catalog templates are used to simplify a view of a catalog and allow easier manipulation of catalogs. The automated conversion pre-generates a basic template that can be turned into full FBC using the following command:
 
 ```bash
 make catalog
 ```
 
 Of course, you can choose any type of template that you prefer by modifying the Makefile target.
-More information about catalog templates can be found [here](https://olm.operatorframework.io/docs/reference/catalog-templates/)
+More information about catalog templates can be found [here](https://olm.operatorframework.io/docs/reference/catalog-templates/)

docs/users/fbc_workflow.md

@@ -24,12 +24,10 @@ template the operator will be using.
 
 * Basic template
 * SemVer template
-* Composite template
 
 More information about each template can be found at [opm doc](https://olm.operatorframework.io/docs/reference/catalog-templates/).
 
-The recommended template from the maintainability point of view is `SemVer` or `Composite` with
-`SemVer`integration.
+The recommended template from the maintainability point of view is `SemVer`.
 
 ## Generate catalogs using templates
 To generate a final catalog for an operator a user needs to execute different `opm`
@@ -51,10 +49,8 @@ The right place for the Makefile is in the operator's root directory
 ├── 0.0.1
 │   ├── manifests
 │   └── metadata
-├── catalogs.yaml
 ├── catalog-templates
 ├── ci.yaml
-├── composite-config.yaml
 └── Makefile
 
 ```
@@ -65,7 +61,7 @@ can be submitted as a PR in Github and once the PR is processed changes will be
 OCP index.
 
 ```bash
-$ tree catalogs
+$ tree (repository-root)/catalogs
 catalogs
 ├── v4.12
 │   └── aqua

fbc/Makefile

@@ -9,7 +9,6 @@
 # OPM allows for the generation of catalogs using different templates.
 # - basic: generates a basic catalog
 # - semver: generates a catalog with semver versioning
-# - composite: generates a catalog using a composite template
 
 PDW=$(shell pwd)
 OPERATOR_NAME=$(shell basename $(PDW))
@@ -49,9 +48,7 @@ fbc-onboarding: fbc-onboarding-deps ${BINDIR}/opm clean
 #
 # --- SEMVER TEMPLATE ---
 #catalog: semver
-#
-# --- COMPOSITE TEMPLATE ---
-catalog: composite
+
 
 # basic target provides an example FBC generation from a `basic` template type.
 # this example takes a single file as input and generates a well-formed FBC operator contribution as an output
@@ -72,13 +69,6 @@ semver: ${BINDIR}/opm clean
 		${BINDIR}/opm alpha render-template semver -o yaml  ${OPERATOR_CATALOG_TEMPLATE_DIR}/$${version}.yaml > ${CATALOG_DIR}/$${version}/${OPERATOR_NAME}/catalog.yaml; \
 	done
 
-# composite target processes a composite template to generate the FBC contributions
-# `render-template composite` has `--validate` option enabled by default,
-# so no subsequent validation is required
-.PHONY: composite
-composite: ${BINDIR}/opm clean
-	${BINDIR}/opm alpha render-template composite -f ${PDW}/catalogs.yaml -c ${PDW}/composite-config.yaml
-
 #
 # validate target illustrates FBC validation
 # all FBC must pass opm validation in order to be able to be used in a catalog

operator-pipeline-images/operatorcert/entrypoints/fbc_onboarding.py

@@ -14,8 +14,6 @@
 
 LOGGER = logging.getLogger("operator-cert")
 
-COMPOSITE_TEMPLATE_CATALOGS = "catalogs.yaml"
-COMPOSITE_TEMPLATE_CONTRIBUTIONS = "composite-config.yaml"
 CATALOG_TEMPLATES_DIR = "catalog-templates"
 
 
@@ -96,7 +94,7 @@ def opm_cache(image: str) -> bytes:
         bytes: An output of the opm command
     """
     LOGGER.debug("Building cache for %s", image)
-    output = run_command(["opm", "render", "-o", "yaml", "--migrate", image])
+    output = run_command(["opm", "render", "-o", "yaml", image])
     return output.stdout
 
 
@@ -205,81 +203,6 @@ def generate_and_save_base_templates(
     LOGGER.info("Template for %s saved to %s", version, template_path)
 
 
-def generate_composite_templates(
-    operator: Operator, catalog_versions: List[str]
-) -> Tuple[Dict[str, Any], Dict[str, Any]]:
-    """
-    Generate a composite template for given operator and all supported versions
-
-    Args:
-        operator (Operator): A operator object
-        catalog_versions (List[str]): List of supported catalog versions
-
-    Returns:
-        Tuple[Dict, Dict]: catalog and contributions templates
-    """
-    catalogs = [
-        {
-            "name": f"v{version}",
-            "destination": {
-                "workingDir": f"../../catalogs/v{version}",
-            },
-            "builders": ["olm.builder.basic", "olm.builder.semver"],
-        }
-        for version in catalog_versions
-    ]
-    composite_catalogs = {
-        "schema": "olm.composite.catalogs",
-        "catalogs": catalogs,
-    }
-
-    components = [
-        {
-            "name": f"v{version}",
-            "destination": {
-                "path": operator.operator_name,
-            },
-            "strategy": {
-                "name": "basic",
-                "template": {
-                    "schema": "olm.builder.basic",
-                    "config": {
-                        "input": f"{CATALOG_TEMPLATES_DIR}/v{version}.yaml",
-                        "output": "catalog.yaml",
-                    },
-                },
-            },
-        }
-        for version in catalog_versions
-    ]
-
-    contributions = {"schema": "olm.composite", "components": components}
-    return composite_catalogs, contributions
-
-
-def generate_and_save_composite_templates(
-    operator: Operator, catalog_versions: List[str]
-) -> None:
-    """
-    Generate and save composite templates for given operator and all supported versions
-
-    Args:
-        operator (Operator): A operator object
-        catalog_versions (List[str]): List of supported catalog versions
-    """
-    catalog, contributions = generate_composite_templates(operator, catalog_versions)
-    with open(
-        os.path.join(operator.root, COMPOSITE_TEMPLATE_CATALOGS), "w", encoding="utf8"
-    ) as f:
-        yaml.safe_dump(catalog, f, explicit_start=True)
-    with open(
-        os.path.join(operator.root, COMPOSITE_TEMPLATE_CONTRIBUTIONS),
-        "w",
-        encoding="utf8",
-    ) as f:
-        yaml.safe_dump(contributions, f, explicit_start=True)
-
-
 def update_operator_config(operator: Operator) -> None:
     """
     Switch operator config to FBC
@@ -299,7 +222,7 @@ def update_operator_config(operator: Operator) -> None:
         yaml.safe_dump(config, f, explicit_start=True)
 
 
-def render_fbc_from_template(operator: Operator) -> None:
+def render_fbc_from_template(operator: Operator, version: str) -> None:
     """
     Render catalog from templates
 
@@ -311,11 +234,12 @@ def render_fbc_from_template(operator: Operator) -> None:
             "opm",
             "alpha",
             "render-template",
-            "composite",
-            "-f",
-            COMPOSITE_TEMPLATE_CATALOGS,
-            "-c",
-            COMPOSITE_TEMPLATE_CONTRIBUTIONS,
+            "basic",
+            "-o",
+            "yaml",
+            os.path.join(operator.root, CATALOG_TEMPLATES_DIR, f"v{version}.yaml"),
+            ">",
+            f"../../catalogs/v{version}/catalog.yaml"
         ],
         cwd=operator.root,
     )
@@ -356,11 +280,8 @@ def onboard_operator_to_fbc(
             version, operator_name, cache_dir, template_dir
         )
 
-    LOGGER.info("Generating composite templates")
-    generate_and_save_composite_templates(operator, supported_versions)
-
-    LOGGER.info("Rendering FBC from templates")
-    render_fbc_from_template(operator)
+        LOGGER.info("Rendering FBC from templates")
+        render_fbc_from_template(operator, version)
 
     LOGGER.info("Updating operator config")
     update_operator_config(operator)