Add JSON support to kustomization files #1392

srfrnk · 2019-07-24T05:07:50Z

This allows you to use kustomization.json files.

Liujingfang1 · 2019-07-24T17:30:29Z

I don't think this will work.
First, you need to add kustomization.json to the file name accepted by kustomize. Once this is done, kustomize run build on it.
To keep the json format of kustomization.json in kustomize edit, you need to marshal it to JSON.
There is another part related, which is more important. kustomize edit tries to keep the order and comments from the original file content. This is done with the assumption that the file is yaml. For the json file, need to do similar thing to keep the order and comments.

srfrnk · 2019-07-25T07:56:49Z

You're right - I forgot to squash and merge in one commit that was necessary.
Now it's complete.
I will look at the order issue as well.

srfrnk · 2019-07-25T13:52:05Z

Looking into the issue it appears that this is a limitation set into Go JSON/YAML parser.
Go assumes the order of JSON properties should not be kept.

Javascript for example does not behave that way:

const obj = JSON.parse('{"c":"1","b":"2","a":"3"}');
console.log(obj, JSON.stringify(obj));

Will produce:

{ c: '1', b: '2', a: '3' } '{"c":"1","b":"2","a":"3"}'

A solution for this use-case may be to use forks for marshaling/marshaling JSON such as this.
However IMHO it poses a larger threat then the issue is worth.

Since the JSON marshaling in Go sorts the properties alphabetically - it is deterministic at least.
I would think this can be an acceptable limitation for JSON kustomization files.
As a user I would be happy living with it - as opposed to not having JSON at all.
Note that after the first edit the order is maintained for every new edit.

Liujingfang1 · 2019-07-30T22:47:44Z

@srfrnk Let's add the support for reading from and writing to kustomization.json file for now. Add some document explaining that the order and comments of JSON kustomization file are not preserved.

k8s-ci-robot · 2019-07-31T06:56:12Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: srfrnk
To complete the pull request process, please assign liujingfang1
You can assign the PR to them by writing /assign @liujingfang1 in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

srfrnk · 2019-07-31T06:58:53Z

@Liujingfang1 I have added the comment into the FAQ: commit
Please note another commit with other changes to docs/comments/messages that might be relevant to YAML/JSON. Please advise if these are not relevant.

Liujingfang1

Let's not adding kustomization.json to every place of kustomization.yaml is present. You can add explanation of the accepted file names only at one place, maybe in the FAQ doc where you add Order and formatting changed when using a JSON kustomization file. For other places, let's just use kustomization.yaml.

Liujingfang1 · 2019-08-01T18:15:59Z

docs/FAQ.md

@@ -33,13 +33,13 @@ kustomize build --load_restrictor none $target

 Example: [#1319](https://github.com/kubernetes-sigs/kustomize/issues/1319), [#1322](https://github.com/kubernetes-sigs/kustomize/issues/1322), [#1347](https://github.com/kubernetes-sigs/kustomize/issues/1347) and etc.

-The fields transformed by kustomize is configured explicitly in [defaultconfig](https://github.com/kubernetes-sigs/kustomize/tree/master/pkg/transformers/config/defaultconfig). The configuration itself can be customized by including `configurations` in `kustomization.yaml`, e.g.
+The fields transformed by kustomize is configured explicitly in [defaultconfig](https://github.com/kubernetes-sigs/kustomize/tree/master/pkg/transformers/config/defaultconfig). The configuration itself can be customized by including `configurations` in `kustomization.yaml`/`kustomization.json`, e.g.


Let's not add kustomization.json here since we don't have the same level support for it.

Liujingfang1 · 2019-08-01T18:17:54Z

docs/fields.md

@@ -1,6 +1,6 @@
 # Kustomization File Fields

-An explanation of the fields in a [kustomization.yaml](glossary.md#kustomization) file.
+An explanation of the fields in a [kustomization.yaml/json](glossary.md#kustomization) file.


Let's not add kustomization.json here since all the following fields are in yaml format.

Liujingfang1 · 2019-08-01T18:18:46Z

docs/fields.md

@@ -401,7 +401,7 @@ field.
 Directory specification can be relative, absolute,
 or part of a URL.  URL specifications should
 follow the [hashicorp URL] format.  The directory
-must contain a `kustomization.yaml` file.
+must contain a `kustomization.yaml` / `kustomization.json` file.


Let's not add kustomization.json here since we didn't do that for other accepted files like kustomization.yml, kustomization.

Liujingfang1 · 2019-08-01T18:20:31Z

pkg/commands/kustfile/kustomizationfile.go

+
+		// Remove `kind` and `apiVersion` so as make minimal changes to original source file:
+		delete(k, "kind")
+		delete(k, "apiVersion")


When the original file contains kind and apiVersion, this will also remove them.
Let's not delete those two fields.

Liujingfang1 · 2019-08-01T18:21:23Z

docs/glossary.md

@@ -152,16 +152,16 @@ test or deploy) when that truth changes.
 ## kustomization

 The term _kustomization_ refers to a
-`kustomization.yaml` file, or more generally to a
+`kustomization.yaml` / `kustomization.json` file, or more generally to a


Let's not add kustomization.json to this doc, since we didn't do that for kustomization.yml or kustomization.

srfrnk · 2019-08-02T05:24:14Z

Removed the second commit. Only the FAQ comment is added.

fejta-bot · 2019-10-31T06:08:24Z

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

monopole · 2019-11-21T21:56:29Z

it looks like this PR was never updated to handle the edit and fix command, and there are no tests showing kustomize.json usage in both commands. To support kustomize.json, we should support it fully or not at all. partial support will just be confusing.

Feel free to reopen, but the bar here has to be high. It's not just about being able to load a json file.

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 24, 2019

k8s-ci-robot requested review from Liujingfang1 and mengqiy July 24, 2019 05:07

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 24, 2019

srfrnk mentioned this pull request Jul 24, 2019

JSON kustomization files are not supported #1393

Closed

srfrnk force-pushed the add-json-support branch from e07913e to 94c496b Compare July 25, 2019 07:23

fix: support JSON kustomization files

aff77e3

srfrnk force-pushed the add-json-support branch from 94c496b to aff77e3 Compare July 27, 2019 14:30

Liujingfang1 self-assigned this Jul 30, 2019

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 31, 2019

Liujingfang1 reviewed Aug 1, 2019

View reviewed changes

Added comment to FAQ re. JSON ksutomization edit field order

3d07892

srfrnk force-pushed the add-json-support branch from d70ebac to 3d07892 Compare August 2, 2019 05:21

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 31, 2019

monopole closed this Nov 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add JSON support to kustomization files #1392

Add JSON support to kustomization files #1392

srfrnk commented Jul 24, 2019

Liujingfang1 commented Jul 24, 2019

srfrnk commented Jul 25, 2019

srfrnk commented Jul 25, 2019 •

edited

Loading

Liujingfang1 commented Jul 30, 2019

k8s-ci-robot commented Jul 31, 2019

srfrnk commented Jul 31, 2019

Liujingfang1 left a comment

Liujingfang1 Aug 1, 2019

Liujingfang1 Aug 1, 2019

Liujingfang1 Aug 1, 2019

Liujingfang1 Aug 1, 2019

Liujingfang1 Aug 1, 2019

srfrnk commented Aug 2, 2019

fejta-bot commented Oct 31, 2019

monopole commented Nov 21, 2019 •

edited

Loading

Add JSON support to kustomization files #1392

Add JSON support to kustomization files #1392

Conversation

srfrnk commented Jul 24, 2019

Liujingfang1 commented Jul 24, 2019

srfrnk commented Jul 25, 2019

srfrnk commented Jul 25, 2019 • edited Loading

Liujingfang1 commented Jul 30, 2019

k8s-ci-robot commented Jul 31, 2019

srfrnk commented Jul 31, 2019

Liujingfang1 left a comment

Choose a reason for hiding this comment

Liujingfang1 Aug 1, 2019

Choose a reason for hiding this comment

Liujingfang1 Aug 1, 2019

Choose a reason for hiding this comment

Liujingfang1 Aug 1, 2019

Choose a reason for hiding this comment

Liujingfang1 Aug 1, 2019

Choose a reason for hiding this comment

Liujingfang1 Aug 1, 2019

Choose a reason for hiding this comment

srfrnk commented Aug 2, 2019

fejta-bot commented Oct 31, 2019

monopole commented Nov 21, 2019 • edited Loading

srfrnk commented Jul 25, 2019 •

edited

Loading

monopole commented Nov 21, 2019 •

edited

Loading