Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(k8s): use yaml 1.1 when reading kubernetes manifests #5184

Merged
merged 2 commits into from
Oct 5, 2023
Merged

fix(k8s): use yaml 1.1 when reading kubernetes manifests #5184

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8eadd53
fix(k8s): use yaml 1.1 when reading kubernetes manifests
stefreak Oct 4, 2023
daf1a57
Merge branch 'main' into kubernetes-yaml-1.1
stefreak Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions core/src/plugins/kubernetes/kubernetes-type/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
import { join, resolve } from "path"
import { pathExists, readFile } from "fs-extra"
import { flatten, keyBy, set } from "lodash"
import { loadAll } from "js-yaml"

import { KubernetesModule } from "./module-config"
import { KubernetesResource } from "../types"
Expand All @@ -30,6 +29,7 @@ import { V1ConfigMap } from "@kubernetes/client-node"
import { glob } from "glob"
import isGlob from "is-glob"
import pFilter from "p-filter"
import { parseAllDocuments } from "yaml"

/**
* "DeployFile": Manifest has been read from one of the files declared in Garden Deploy `spec.files`
Expand Down Expand Up @@ -300,7 +300,7 @@ async function readKustomizeManifests(
log,
args: ["build", kustomizePath, ...extraArgs],
})
const manifests = expandListManifests(loadAll(kustomizeOutput) as KubernetesResource[])
const manifests = parseKubernetesManifests(kustomizeOutput)
return manifests.map((manifest, index) => ({
declaration: {
type: "kustomize",
Expand Down Expand Up @@ -357,7 +357,7 @@ async function readFileManifests(
log.debug(`Reading manifest for ${action.longDescription()} from path ${absPath}`)
const str = (await readFile(absPath)).toString()
const resolved = ctx.resolveTemplateStrings(str, { allowPartial: true, unescape: true })
const manifests = expandListManifests(loadAll(resolved) as KubernetesResource[])
const manifests = parseKubernetesManifests(resolved)
return manifests.map((manifest, index) => ({
declaration: {
type: "file",
Expand All @@ -371,6 +371,39 @@ async function readFileManifests(
)
}

/**
* Correctly parses Kubernetes manifests: Kubernetes uses the YAML 1.1 spec by default and not YAML 1.2, which is the default for most libraries.
*
* @throws ConfigurationError on parser errors.
* @param str raw string containing Kubernetes manifests in YAML format
*/
function parseKubernetesManifests(str: string): KubernetesResource[] {
const docs = Array.from(
parseAllDocuments(str, {
// Kubernetes uses the YAML 1.1 spec by default and not YAML 1.2, which is the default for most libraries.
// See also https://github.com/kubernetes/kubernetes/issues/34146
schema: "yaml-1.1",
strict: false,
})
)

for (const doc of docs) {
if (doc.errors.length > 0) {
throw new ConfigurationError({
message: `Failed to parse Kubernetes manifest: ${doc.errors[0]}`,
})
}
}

// TODO: We should use schema validation to make sure that apiVersion, kind and metadata are always defined as required by the type.
const manifests = docs.map((d) => d.toJS()) as KubernetesResource[]

return expandListManifests(manifests)
}

/**
* Expands Kubernetes List manifests into their items.
*/
function expandListManifests(manifests: KubernetesResource[]): KubernetesResource[] {
return manifests.flatMap((manifest) => {
if (manifest?.kind?.endsWith("List")) {
Expand Down