salt, build: automate catalogd install

BUMPING.md

@@ -70,11 +70,7 @@ REPO_URL=https://grafana.github.io/helm-charts
 
 ### ingress-nginx
 
-```
-CHART_NAME=ingress-nginx
-REPO_NAME=ingress-nginx
-REPO_URL=https://kubernetes.github.io/ingress-nginx
-```
+see [nginx-operator](./nginx-operator/BUMPING.md) and [metalk8s-catalog-source](./catalog-source/README.md)
 
 set `$VERSION` with the appropriate value.
 

buildchain/buildchain/codegen.py

@@ -125,60 +125,6 @@ def codegen_chart_fluent_bit() -> types.TaskDict:
     }
 
 
-def codegen_chart_ingress_nginx() -> types.TaskDict:
-    """Generate the SLS file for NGINX Ingress using the chart render script."""
-    chart_dir = constants.CHART_ROOT / "ingress-nginx"
-    ingress_nginx_namespace = "metalk8s-ingress"
-    actions = []
-    file_dep = list(utils.git_ls(chart_dir))
-    file_dep.append(constants.CHART_RENDER_SCRIPT)
-
-    # Workload Plane Ingress
-    target_sls = (
-        constants.ROOT / "salt/metalk8s/addons/nginx-ingress/deployed/chart.sls"
-    )
-    chart_name = "ingress-nginx"
-    value_file = constants.CHART_ROOT / f"{chart_name}.yaml"
-    actions.append(
-        doit.action.CmdAction(
-            f"{constants.CHART_RENDER_CMD} {chart_name} {value_file} {chart_dir} "
-            f"--namespace {ingress_nginx_namespace} --remove-manifest ConfigMap "
-            f"{chart_name}-controller "
-            f"--output {target_sls}",
-            cwd=constants.ROOT,
-        )
-    )
-    file_dep.append(value_file)
-
-    # Control Plane Ingress
-    target_sls = (
-        constants.ROOT
-        / "salt/metalk8s/addons/nginx-ingress-control-plane"
-        / "deployed/chart.sls"
-    )
-    chart_name = "ingress-nginx-control-plane"
-    value_file = constants.CHART_ROOT / f"{chart_name}.yaml"
-    actions.append(
-        doit.action.CmdAction(
-            f"{constants.CHART_RENDER_CMD} {chart_name} {value_file} {chart_dir} "
-            f"--namespace {ingress_nginx_namespace} --remove-manifest ConfigMap "
-            f"{chart_name}-controller "
-            f"--output {target_sls}",
-            cwd=constants.ROOT,
-        )
-    )
-    file_dep.append(value_file)
-
-    return {
-        "name": "chart_ingress-nginx",
-        "title": utils.title_with_subtask_name("CODEGEN"),
-        "doc": codegen_chart_ingress_nginx.__doc__,
-        "actions": actions,
-        "file_dep": file_dep,
-        "task_dep": ["check_for:tox", "check_for:helm"],
-    }
-
-
 def codegen_chart_kube_prometheus_stack() -> types.TaskDict:
     """Generate the SLS file for Kube Prometheus Stack using the chart render script."""
     target_sls = (
@@ -332,19 +278,39 @@ def codegen_chart_cert_manager() -> types.TaskDict:
         "task_dep": ["check_for:tox", "check_for:helm"],
     }
 
+def codegen_olm() -> types.TaskDict:
+    """Generate the SLS file for OLMv1 using the OLM render script."""
+    target_sls = constants.ROOT / "salt/metalk8s/addons/olm/deployed/chart.sls"
+    cmd = (
+        f"{constants.OLM_RENDER_CMD} "
+        f"--output {target_sls}"
+    )
+
+    file_dep = [ constants.OLM_RENDER_SCRIPT ]
+
+    return {
+        "name": "olm",
+        "title": utils.title_with_subtask_name("CODEGEN"),
+        "doc": codegen_olm.__doc__,
+        "actions": [doit.action.CmdAction(cmd, cwd=constants.ROOT)],
+        "file_dep": file_dep,
+        "task_dep": ["check_for:tox"],
+    }
+
+
 
 # List of available code generation tasks.
 CODEGEN: Tuple[Callable[[], types.TaskDict], ...] = (
     codegen_storage_operator,
     codegen_metalk8s_operator,
     codegen_chart_dex,
     codegen_chart_fluent_bit,
-    codegen_chart_ingress_nginx,
     codegen_chart_kube_prometheus_stack,
     codegen_chart_loki,
     codegen_chart_prometheus_adapter,
     codegen_chart_thanos,
     codegen_chart_cert_manager,
+    codegen_olm,
 )
 
 

buildchain/buildchain/constants.py

@@ -32,6 +32,7 @@
 PROMETHEUS_REPOSITORY: str = "quay.io/prometheus"
 THANOS_REPOSITORY: str = "quay.io/thanos"
 CERT_MANAGER_REPOSITORY: str = "quay.io/jetstack"
+OPERATOR_FRAMEWORK_REPOSITORYT: str = "quay.io/operator-framework"
 
 # Paths {{{
 
@@ -58,11 +59,15 @@
 # Path to the MetalK8s operator source directory
 METALK8S_OPERATOR_ROOT: Path = ROOT / "operator"
 # Path to the storage-operator source directory.
+NGINX_OPERATOR_ROOT: Path = ROOT / "nginx-operator"
+# Path to the nginx-operator source directory.
 STORAGE_OPERATOR_ROOT: Path = ROOT / "storage-operator"
 # Path to the UI build root directory.
 UI_BUILD_ROOT: Path = config.BUILD_ROOT / "ui"
 # Path to the shell-ui build root directory.
 SHELL_UI_BUILD_ROOT: Path = config.BUILD_ROOT / "shell-ui"
+# Path to the MetalK8s Catalog Source root directory
+CATALOG_SOURCE_ROOT: Path = ROOT / "catalog-source"
 
 # Docker entrypoints.
 REDHAT_ENTRYPOINT: Path = ROOT / "packages/redhat/common/entrypoint.sh"
@@ -76,6 +81,8 @@
 CHART_ROOT: Path = ROOT / "charts"
 CHART_RENDER_SCRIPT: Path = CHART_ROOT / "render.py"
 
+OLM_RENDER_SCRIPT: Path = ROOT / "olm/render.py"
+
 # }}}
 # Vagrant parameters {{{
 
@@ -145,6 +152,7 @@ def git_ref() -> Optional[str]:
 ]
 
 CHART_RENDER_CMD: str = f"tox -e chart-render -- --kube-version {versions.K8S_VERSION}"
+OLM_RENDER_CMD: str = f"tox -e olm-render -- -v v{versions.OLM_VERSION}"
 
 # For mypy, see `--no-implicit-reexport` documentation.
 __all__ = ["ROOT"]

buildchain/buildchain/image.py

@@ -217,6 +217,11 @@ def _local_image(name: str, **kwargs: Any) -> targets.LocalImage:
         "cert-manager-cainjector",
         "cert-manager-acmesolver",
     ],
+    constants.OPERATOR_FRAMEWORK_REPOSITORYT: [
+        "catalogd",
+        "operator-controller",
+        "opm"
+    ],
 }
 
 REMOTE_NAMES: Dict[str, str] = {
@@ -323,6 +328,24 @@ def _local_image(name: str, **kwargs: Any) -> targets.LocalImage:
             "VERSION": versions.VERSION,
         },
     ),
+    _local_image(
+        name="nginx-operator",
+        dockerfile=constants.NGINX_OPERATOR_ROOT / "Dockerfile",
+        build_context=constants.NGINX_OPERATOR_ROOT,
+    ),
+    _local_image(
+        name="nginx-operator-bundle",
+        dockerfile=constants.NGINX_OPERATOR_ROOT / "bundle.Dockerfile",
+        build_context=constants.NGINX_OPERATOR_ROOT,
+    ),
+    _local_image(
+        name="metalk8s-catalog-source",
+        dockerfile=constants.CATALOG_SOURCE_ROOT / "catalog.Dockerfile",
+        build_context=constants.CATALOG_SOURCE_ROOT,
+        build_args={
+            "BASE_IMG": TO_PULL["opm"].remote_fullname_digest,
+        },
+    ),
 )
 # }}}
 

buildchain/buildchain/salt_tree.py

@@ -344,6 +344,14 @@ def task(self) -> types.TaskDict:
         file_dep=[METALK8S_OPERATOR_MANIFESTS],
     ),
     Path("salt/metalk8s/addons/metalk8s-operator/deployed/init.sls"),
+    Path("salt/metalk8s/addons/nginx-operator/deployed/clusterextension.sls"),
+    Path("salt/metalk8s/addons/nginx-operator/deployed/init.sls"),
+    Path("salt/metalk8s/addons/nginx-operator/deployed/namespace.sls"),
+    Path("salt/metalk8s/addons/nginx-operator/deployed/rbac.sls"),
+    Path("salt/metalk8s/addons/olm/catalog/deployed/cluster-catalog.sls"),
+    Path("salt/metalk8s/addons/olm/catalog/deployed/init.sls"),
+    Path("salt/metalk8s/addons/olm/deployed/chart.sls"),
+    Path("salt/metalk8s/addons/olm/deployed/init.sls"),
     Path("salt/metalk8s/addons/prometheus-adapter/deployed/chart.sls"),
     Path("salt/metalk8s/addons/prometheus-adapter/deployed/init.sls"),
     Path("salt/metalk8s/addons/prometheus-operator/macros.j2"),
@@ -680,6 +688,7 @@ def task(self) -> types.TaskDict:
     Path("salt/_modules/metalk8s_kubernetes_utils.py"),
     Path("salt/_modules/metalk8s_monitoring.py"),
     Path("salt/_modules/metalk8s_network.py"),
+    Path("salt/_modules/metalk8s_olm.py"),
     Path("salt/_modules/metalk8s_os.py"),
     Path("salt/_modules/metalk8s_package_manager_yum.py"),
     Path("salt/_modules/metalk8s_service_configuration.py"),

buildchain/buildchain/versions.py

@@ -28,10 +28,13 @@
 CALICO_VERSION: str = "3.29.0"
 SALT_VERSION: str = "3002.9"
 CONTAINERD_VERSION: str = "1.6.36"
+NGINX_OPERATOR_VERSION: str = "4.11.3"
 
 CONTAINERD_RELEASE: str = "1"
 SOSREPORT_RELEASE: str = "2"
 
+OLM_VERSION: str = "1.1.0"
+
 
 def load_version_information() -> None:
     """Load version information from `VERSION`."""
@@ -225,6 +228,16 @@ def _version_prefix(version: str, prefix: str = "v") -> str:
         version="v0.36.1",
         digest="sha256:e542959e1b36d5046083d1b64a7049c356b68a44a173c58b3ae7c0c9ada932d5",
     ),
+    Image(
+        name="catalogd",
+        version=_version_prefix(OLM_VERSION),
+        digest="sha256:95477a136772765fa2cfb02a6e5fb52bcc167ef7b5333f9e238b0b13b9e72f7b",
+    ),
+    Image(
+        name="operator-controller",
+        version=_version_prefix(OLM_VERSION),
+        digest="sha256:6272919257e695fcdadf0b57cc0a272084ebf2caca7571e2e5d79d6a56a788fa",
+    ),
     # Local images
     Image(
         name="metalk8s-alert-logger",
@@ -266,6 +279,26 @@ def _version_prefix(version: str, prefix: str = "v") -> str:
         version=VERSION,
         digest=None,
     ),
+    Image(
+        name="nginx-operator",
+        version=_version_prefix(NGINX_OPERATOR_VERSION),
+        digest=None,
+    ),
+    Image(
+        name="nginx-operator-bundle",
+        version=_version_prefix(NGINX_OPERATOR_VERSION),
+        digest=None,
+    ),
+    Image(
+        name="opm",
+        version="v1.49.0",
+        digest="sha256:0bbe4054f2f88410ae364169379639c06b0e253d6e233bc24fcf2c0cd2d9803d",
+    ),
+    Image(
+        name="metalk8s-catalog-source",
+        version=VERSION,
+        digest=None,
+    ),
     Image(
         name="loki",
         version="3.2.0",

buildchain/static-container-registry/static-container-registry.py

@@ -118,6 +118,10 @@ def create_config(
     types {{ }} default_type "application/json";
     return 200 '{payload:s}';
 }}
+location = /v2/{name:s}/tags/list {{
+    types {{ }} default_type "application/json";
+    return 200 '{payload:s}';
+}}
 """.format(
             name=name,
             name_prefix=name_prefix.lstrip("/"),
@@ -145,6 +149,13 @@ def create_config(
     try_files manifest.json =404;
     error_page 404 @404_tag;
 }}
+location = "/v2/{name:s}/manifests/{tag:s}" {{
+    alias {server_root:s}/{name:s}/{tag:s}/;
+    types {{ }} default_type "application/vnd.docker.distribution.manifest.v2+json";
+    add_header 'Docker-Content-Digest' 'sha256:{digest:s}';
+    try_files manifest.json =404;
+    error_page 404 @404_tag;
+}}
 """.format(
                 name=name,
                 tag=tag,
@@ -162,6 +173,13 @@ def create_config(
     try_files manifest.json =404;
     error_page 404 @404_tag;
 }}
+location = "/v2/{name:s}/manifests/sha256:{digest:s}" {{
+    alias {server_root:s}/{name:s}/{tag:s}/;
+    types {{ }} default_type "application/vnd.docker.distribution.manifest.v2+json";
+    add_header 'Docker-Content-Digest' 'sha256:{digest:s}';
+    try_files manifest.json =404;
+    error_page 404 @404_tag;
+}}
 """.format(
                     name=name,
                     tag=tag,
@@ -184,6 +202,10 @@ def create_config(
     alias {server_root:s}/{name:s}/;
     try_files {paths:s} =404;
 }}
+location ~ "/v2/{name:s}/blobs/sha256:([a-f0-9]{{64}})" {{
+    alias {server_root:s}/{name:s}/;
+    try_files {paths:s} =404;
+}}
 """.format(
             name_prefix=name_prefix.lstrip("/"),
             server_root=server_root,

catalog-source/.indexignore

@@ -0,0 +1,2 @@
+README.md
+*.Dockerfile

catalog-source/README.md

@@ -0,0 +1,5 @@
+# MetalK8s catalog source for OLMv1
+
+contains the current operators:
+
+ - MetalK8s [nginx-operator](../nginx-operator)

catalog-source/catalog.Dockerfile

@@ -0,0 +1,23 @@
+ARG BASE_IMG=quay.io/operator-framework/opm:latest
+# The builder image is expected to contain
+# /bin/opm (with serve subcommand)
+FROM ${BASE_IMG} as builder
+
+# Copy FBC root into image at /configs and pre-populate serve cache
+ADD catalog /configs
+RUN ["/bin/opm", "serve", "/configs", "--cache-dir=/tmp/cache", "--cache-only"]
+
+FROM ${BASE_IMG}
+# The base image is expected to contain
+# /bin/opm (with serve subcommand) and /bin/grpc_health_probe
+
+# Configure the entrypoint and command
+ENTRYPOINT ["/bin/opm"]
+CMD ["serve", "/configs", "--cache-dir=/tmp/cache"]
+
+COPY --from=builder /configs /configs
+COPY --from=builder /tmp/cache /tmp/cache
+
+# Set FBC-specific label for the location of the FBC root directory
+# in the image
+LABEL operators.operatorframework.io.index.configs.v1=/configs

catalog-source/catalog/.indexignore

@@ -0,0 +1 @@
+README.md

catalog-source/catalog/nginx-operator/channels/stable.yaml

@@ -0,0 +1,6 @@
+---
+schema: olm.channel
+package: nginx-operator
+name: stable
+entries:
+  - name: nginx-operator.v4.11.3

catalog-source/catalog/nginx-operator/package.yaml

@@ -0,0 +1,8 @@
+---
+defaultChannel: stable
+description: |
+  # NGINX-operator
+
+  This operator manages IngressNginx CRs and uses them as a values file for the [ingress-nginx](https://github.com/kubernetes/ingress-nginx) helm chart.
+name: nginx-operator
+schema: olm.package