Kargo Render should ignore contents of configmap when rendering

[jimil749]

I am trying to render manifest for apache airflow (by using kustomize + upstream helm charts). It includes a configmap manifest which looks like following:

apiVersion: v1
data:
  mappings.yml: |-
    # Licensed to the Apache Software Foundation (ASF) under one
    # or more contributor license agreements.  See the NOTICE file
    # distributed with this work for additional information
    # regarding copyright ownership.  The ASF licenses this file
    # to you under the Apache License, Version 2.0 (the
    # "License"); you may not use this file except in compliance
    # with the License.  You may obtain a copy of the License at
    #
    #   http://www.apache.org/licenses/LICENSE-2.0
    #
    # Unless required by applicable law or agreed to in writing,
    # software distributed under the License is distributed on an
    # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    # KIND, either express or implied.  See the License for the
    # specific language governing permissions and limitations
    # under the License.
    ---
    mappings:
     ...
kind: ConfigMap
metadata:
  labels:
    chart: airflow-1.11.0
    component: config
    heritage: Helm
    release: airflow
    tier: airflow
  name: airflow-statsd

This breaks the render with the following error:

level=fatal msg="error writing manifests for app \"airflow\" to \"/tmp/2142585927/repo/airflow\": resource is missing kind field"

This is because of "---" in the configmap data. Render splits the above manifest into 2 parts (since it uses "---" as the separator) which cause the render to fail.

Render would work fine if it is possible to just ignore the contents of cm.

[krancour]

@jimil749 I assume you don't mean that the contents of a cm shouldn't be rendered. I assume you mean we should take greater care here to only split on --- if it appears at the beginning of a line?

kargo-render/internal/manifests/manifests.go

Lines 29 to 56 in 6de5d79

	func SplitYAML(manifest []byte) (map[string][]byte, error) {
	manifests := bytes.Split(manifest, []byte("---\n"))
	manifestsByResourceTypeAndName := map[string][]byte{}
	for _, manifest = range manifests {
	resource := struct {
	Kind string `json:"kind"`
	Metadata struct {
	Name string `json:"name"`
	} `json:"metadata"`
	}{}
	if err := yaml.Unmarshal(manifest, &resource); err != nil {
	return nil, fmt.Errorf("error unmarshaling resource: %w", err)
	}
	if resource.Kind == "" {
	return nil, errors.New("resource is missing kind field")
	}
	if resource.Metadata.Name == "" {
	return nil, errors.New("resource is missing metadata.name field")
	}
	resourceTypeAndName := fmt.Sprintf(
	"%s-%s",
	strings.ToLower(resource.Metadata.Name),
	strings.ToLower(resource.Kind),
	)
	manifestsByResourceTypeAndName[resourceTypeAndName] = manifest
	}
	return manifestsByResourceTypeAndName, nil
	}

If that was your meaning, I agree.

[jimil749]

@krancour exactly. Contents of a cm should be rendered but greater care needs to take to split on ---.

[benjamin-bergia]

This seems to be happening a quite a few charts.