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.

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

Move YAML decode logic into provider #925

Merged
merged 11 commits into from
Jan 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## 1.4.1 (December 17, 2019)

### Improvements

- Move YAML decode logic into provider. (https://github.com/pulumi/pulumi-kubernetes/pull/925).

### Bug fixes

- Fix deprecation warnings and docs. (https://github.com/pulumi/pulumi-kubernetes/pull/918 and https://github.com /pulumi/pulumi-kubernetes/pull/921).
Expand Down
81 changes: 6 additions & 75 deletions pkg/gen/nodejs-templates/helm/v2/helm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -219,93 +219,24 @@ export class Chart extends yaml.CollectionComponentResource {
}

parseTemplate(
yamlStream: string,
text: string,
transformations: ((o: any, opts: pulumi.CustomResourceOptions) => void)[] | undefined,
resourcePrefix: string | undefined,
dependsOn: pulumi.Resource[],
): pulumi.Output<{ [key: string]: pulumi.CustomResource }> {
// NOTE: We must manually split the YAML stream because of js-yaml#456. Perusing the code
// and the spec, it looks like a YAML stream is delimited by `^---`, though it is difficult
// to know for sure.
//
// NOTE: We use `{json: true, schema: jsyaml.CORE_SCHEMA}` here so that we conform to Helm's
// YAML parsing semantics. Specifically, `json: true` to ensure that a duplicate key
// overrides its predecessory, rather than throwing an exception, and `schema:
// jsyaml.CORE_SCHEMA` to avoid using additional YAML parsing rules not supported by the
// YAML parser used by Kubernetes.
const objs = yamlStream.split(/^---/m)
.map(yaml => jsyaml.safeLoad(yaml, {json: true, schema: jsyaml.CORE_SCHEMA}))
.filter(a => a != null && "kind" in a)
.sort(helmSort);
return yaml.parse(
const promise = pulumi.runtime.invoke(
"kubernetes:yaml:decode", {text}, {async: true});
return pulumi.output(promise).apply(p => yaml.parse(
{
resourcePrefix: resourcePrefix,
yaml: objs.map(o => jsyaml.safeDump(o)),
objs: p.result,
transformations: transformations || [],
},
{ parent: this, dependsOn: dependsOn }
);
));
}
}

// helmSort is a JavaScript implementation of the Helm Kind sorter[1]. It provides a
// best-effort topology of Kubernetes kinds, which in most cases should ensure that resources
// that must be created first, are.
//
// [1]: https://github.com/helm/helm/blob/094b97ab5d7e2f6eda6d0ab0f2ede9cf578c003c/pkg/tiller/kind_sorter.go
/** @ignore */ export function helmSort(a: { kind: string }, b: { kind: string }): number {
const installOrder = [
"Namespace",
"ResourceQuota",
"LimitRange",
"PodSecurityPolicy",
"Secret",
"ConfigMap",
"StorageClass",
"PersistentVolume",
"PersistentVolumeClaim",
"ServiceAccount",
"CustomResourceDefinition",
"ClusterRole",
"ClusterRoleBinding",
"Role",
"RoleBinding",
"Service",
"DaemonSet",
"Pod",
"ReplicationController",
"ReplicaSet",
"Deployment",
"StatefulSet",
"Job",
"CronJob",
"Ingress",
"APIService"
];

const ordering: { [key: string]: number } = {};
installOrder.forEach((_, i) => {
ordering[installOrder[i]] = i;
});

const aKind = a["kind"];
const bKind = b["kind"];

if (!(aKind in ordering) && !(bKind in ordering)) {
return aKind.localeCompare(bKind);
}

if (!(aKind in ordering)) {
return 1;
}

if (!(bKind in ordering)) {
return -1;
}

return ordering[aKind] - ordering[bKind];
}

/**
* Additional options to customize the fetching of the Helm chart.
*/
Expand Down
35 changes: 11 additions & 24 deletions pkg/gen/nodejs-templates/yaml.ts.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ import * as outputs from "../types/output";

export interface ConfigOpts {
/** JavaScript objects representing Kubernetes resources. */
objs: any[];
objs: pulumi.Input<pulumi.Input<any>[]>;

/**
* A set of transformations to apply to Kubernetes resource definitions before registering
Expand Down Expand Up @@ -120,14 +120,10 @@ import * as outputs from "../types/output";
resourcePrefix?: string;
}

function yamlLoadAll(text: string): any[] {
// NOTE[pulumi-kubernetes#501]: Use `loadAll` with `JSON_SCHEMA` here instead of
// `safeLoadAll` because the latter is incompatible with `JSON_SCHEMA`. It is
// important to use `JSON_SCHEMA` here because the fields of the Kubernetes core
// API types are all tagged with `json:`, and they don't deal very well with things
// like dates.
const jsyaml = require("js-yaml");
return jsyaml.loadAll(text, undefined, {schema: jsyaml.JSON_SCHEMA});
function yamlLoadAll(text: string): Promise<any[]> {
const promise = pulumi.runtime.invoke(
"kubernetes:yaml:decode", {text}, {async: true});
return promise.then(p => p.result);
}

/** @ignore */ export function parse(
Expand Down Expand Up @@ -340,22 +336,13 @@ import * as outputs from "../types/output";
config: ConfigOpts,
opts?: pulumi.CustomResourceOptions,
): pulumi.Output<{[key: string]: pulumi.CustomResource}> {
const objs: pulumi.Output<{name: string, resource: pulumi.CustomResource}>[] = [];
return pulumi.output(config.objs).apply(configObjs => {
const objs = configObjs
.map(obj => parseYamlObject(obj, config.transformations, config.resourcePrefix, opts))
.reduce((array, objs) => (array.concat(...objs)), []);

for (const obj of config.objs) {
const fileObjects: pulumi.Output<{name: string, resource: pulumi.CustomResource}>[] =
parseYamlObject(obj, config.transformations, config.resourcePrefix, opts);
for (const fileObject of fileObjects) {
objs.push(fileObject);
}
}
return pulumi.all(objs).apply(xs => {
let resources: {[key: string]: pulumi.CustomResource} = {};
for (const x of xs) {
resources[x.name] = x.resource
}

return resources;
return pulumi.output(objs).apply(objs => objs
.reduce((map: {[key: string]: pulumi.CustomResource}, val) => (map[val.name] = val.resource, map), {}))
});
}

Expand Down
7 changes: 4 additions & 3 deletions pkg/gen/python-templates/helm/v2/helm.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
from typing import Any, Callable, List, Optional, TextIO, Tuple, Union

import pulumi.runtime
import yaml
from pulumi_kubernetes.yaml import _parse_yaml_document


Expand Down Expand Up @@ -348,10 +347,12 @@ def _parse_chart(all_config: Tuple[str, Union[ChartOpts, LocalChartOpts], pulumi
cmd.extend(home_arg)

chart_resources = pulumi.Output.all(cmd, data).apply(_run_helm_cmd)
objects = chart_resources.apply(
lambda text: pulumi.runtime.invoke('kubernetes:yaml:decode', {'text': text}).value['result'])

# Parse the manifest and create the specified resources.
resources = chart_resources.apply(
lambda yaml_str: _parse_yaml_document(yaml.safe_load_all(yaml_str), opts, config.transformations))
resources = objects.apply(
lambda objects: _parse_yaml_document(objects, opts, config.transformations))

pulumi.Output.all(file, chart_dir, resources).apply(_cleanup_temp_dir)
return resources
Expand Down
9 changes: 4 additions & 5 deletions pkg/gen/python-templates/yaml.py.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ from typing import Callable, Dict, List, Optional

import pulumi.runtime
import requests
import yaml
import pulumi_kubernetes
from pulumi_kubernetes.apiextensions import CustomResource

from . import tables
Expand All @@ -25,7 +23,6 @@ class ConfigFile(pulumi.ComponentResource):
Kubernetes resources contained in this ConfigFile.
"""


def __init__(self, name, file_id, opts=None, transformations=None, resource_prefix=None):
"""
:param str name: A name for a resource.
Expand Down Expand Up @@ -63,7 +60,8 @@ class ConfigFile(pulumi.ComponentResource):
# Note: Unlike NodeJS, Python requires that we "pull" on our futures in order to get them scheduled for
# execution. In order to do this, we leverage the engine's RegisterResourceOutputs to wait for the
# resolution of all resources that this YAML document created.
self.resources = _parse_yaml_document(yaml.safe_load_all(text), opts, transformations, resource_prefix)
__ret__ = pulumi.runtime.invoke('kubernetes:yaml:decode', {'text': text}).value['result']
self.resources = _parse_yaml_document(__ret__, opts, transformations, resource_prefix)
self.register_outputs({"resources": self.resources})

def translate_output_property(self, prop: str) -> str:
Expand All @@ -84,12 +82,13 @@ class ConfigFile(pulumi.ComponentResource):

# `id` will either be `${name}` or `${namespace}/${name}`.
id = pulumi.Output.from_input(name)
if namespace != None:
if namespace is not None:
id = pulumi.Output.concat(namespace, '/', name)

resource_id = id.apply(lambda x: f'{group_version_kind}:{x}')
return resource_id.apply(lambda x: self.resources[x])


def _read_url(url: str) -> str:
response = requests.get(url)
response.raise_for_status()
Expand Down
49 changes: 49 additions & 0 deletions pkg/provider/invoke_decode_yaml.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// Copyright 2016-2019, Pulumi Corporation.
//
// Licensed 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.

package provider

import (
"io"
"io/ioutil"
"strings"

"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/util/yaml"
)

// decodeYaml parses a YAML string, and then returns a slice of untyped structs that can be marshalled into
// Pulumi RPC calls.
func decodeYaml(text string) ([]interface{}, error) {
var resources []unstructured.Unstructured

dec := yaml.NewYAMLOrJSONDecoder(ioutil.NopCloser(strings.NewReader(text)), 128)
for {
var value map[string]interface{}
if err := dec.Decode(&value); err != nil {
if err == io.EOF {
break
}
return nil, err
}
resources = append(resources, unstructured.Unstructured{Object: value})
}

result := make([]interface{}, len(resources))
for _, resource := range resources {
result = append(result, resource.Object)
}

return result, nil
pgavlin marked this conversation as resolved.
Show resolved Hide resolved
}
38 changes: 36 additions & 2 deletions pkg/provider/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ const (
streamInvokeList = "kubernetes:kubernetes:list"
streamInvokeWatch = "kubernetes:kubernetes:watch"
streamInvokePodLogs = "kubernetes:kubernetes:podLogs"
invokeDecodeYaml = "kubernetes:yaml:decode"
lastAppliedConfigKey = "kubectl.kubernetes.io/last-applied-configuration"
initialApiVersionKey = "__initialApiVersion"
)
Expand Down Expand Up @@ -376,9 +377,42 @@ func (k *kubeProvider) Configure(_ context.Context, req *pulumirpc.ConfigureRequ
func (k *kubeProvider) Invoke(ctx context.Context,
req *pulumirpc.InvokeRequest) (*pulumirpc.InvokeResponse, error) {

// Always fail.
tok := req.GetTok()
return nil, fmt.Errorf("Unknown Invoke type '%s'", tok)
label := fmt.Sprintf("%s.Invoke(%s)", k.label(), tok)
args, err := plugin.UnmarshalProperties(
req.GetArgs(), plugin.MarshalOptions{Label: label, KeepUnknowns: true})
if err != nil {
return nil, pkgerrors.Wrapf(err, "failed to unmarshal %v args during an Invoke call", tok)
}

switch tok {
case invokeDecodeYaml:
var text string
if args["text"].HasValue() {
text = args["text"].StringValue()
} else {
return nil, fmt.Errorf("missing required field 'text' on input: %#v", args)
}

result, err := decodeYaml(text)
if err != nil {
return nil, err
}

objProps, err := plugin.MarshalProperties(
resource.NewPropertyMapFromMap(map[string]interface{}{"result": result}),
plugin.MarshalOptions{
Label: label, KeepUnknowns: true, SkipNulls: true,
})
if err != nil {
return nil, err
}

return &pulumirpc.InvokeResponse{Return: objProps}, nil

default:
return nil, fmt.Errorf("unknown Invoke type %q", tok)
}
}

// StreamInvoke dynamically executes a built-in function in the provider. The result is streamed
Expand Down
Loading