Implement param pointers to Nulecule spec. #191

cdrage · 2015-11-27T15:14:33Z

This implements XPathing as per the Atomic App PR projectatomic/atomicapp#366.

Fixes issue #70.

I'm not too good at modfying / changing spec information, so will need some input from @bexelbie and @aweiteka

goern · 2015-12-01T15:38:59Z

spec/README.md

@@ -186,6 +186,37 @@ Field Name | Type | Description
 <a name="parametersDefault"></a>default | `string` | **Optional** An optional default value for the parameter.
 <a name="parametersHidden"></a>hidden | `string` | **Optional** An optional boolean signifying the parameter should be obscured when displayed.

+##### XPathing
+XPathing is supported by the Nulecule spec as by [RFC 6902](https://tools.ietf.org/html/rfc6902).


its "Nulecule Specification"

Ah, I should clarify that the RFC implements JSON pointers (inherentdly how we do xpathing)

goern · 2015-12-01T15:49:21Z

can you add a little why and what to the XPath chapter. Same for "XPathing", it seems to be called JSON patching, as in the RFC you mentioned.

aweiteka · 2015-12-02T13:59:29Z

spec/param.json

@@ -28,6 +28,10 @@
            "description": "An optional boolean signifying the parameter should be obscured when displayed.",
            "type": "boolean",
            "default": false
-        }
+        },


In this file we're providing a programatic view of what the data structure looks like, not an example.

aweiteka · 2015-12-02T14:13:12Z

Per atomicapp pr#366 shouldn't this be part of the artifacts object?

cdrage · 2015-12-02T14:21:24Z

@aweiteka @goern

Yes, it's suppose to be part of the artifacts object but I was unable to find a clean example to indicate it (the spec uses different definitions than our atomic app implementation).

~~Could one of you please take-over this issue and possibly create another PR to merge in? I'm not too good at modifying/improving specifications.~~
let me update and try again :)

cdrage · 2015-12-17T16:31:07Z

ping @aweiteka @goern updated again

cdrage · 2015-12-21T16:26:10Z

timeout... pinging again
@goern @aweiteka

and @vpavlin

aweiteka · 2015-12-22T13:06:00Z

@cdrage I'm confused how this relates to this[1]. It seems like a duplication. I don't want to ask more of you so I think at this point I would like to take a pass at this. Would you mind?

[1] 7a83d58

cdrage · 2015-12-22T16:09:35Z

@aweiteka
That would be my mistake, seems I had merged xpathing during the 0.3.0 release by mistake. I've since reverted that.

Feel free to check this PR again :)

aweiteka · 2015-12-22T19:23:20Z

param:
  - /spec/containers/0/param

I still can't reconcile this with atomicapp implementation projectatomic/atomicapp#366 . I don't think it belongs in constraints. I also believe it is better described in artifacts, not params definition.

aweiteka · 2015-12-22T19:24:09Z

@cdrage I submitted PR to update your branch.

Describe param as structured data

cdrage · 2016-01-12T16:58:14Z

ping @aweiteka @bexelbie can we merge this?

cdrage · 2016-02-11T18:38:18Z

timeout, pinging again @aweiteka @bexelbie

goern · 2016-02-11T19:40:17Z

LGTM

@vpavlin ?

bexelbie · 2016-02-12T09:51:04Z

I agree with @aweiteka that this belongs in the artifacts section or at least not in constraints.

If atomic app varies from the spec we should rationalize the two. Perhaps we need a working spec call?

cdrage · 2016-03-14T03:35:03Z

@bexelbie @goern @dustymabe

This is badddd documentation in my regards, this should have never been committed. I will update this.

I also vote to move more towards yaml instead since it gives a lot more clarity in regards to the spec (not only the xpathing examples).

This is what xpathing looks like within Atomic App and thus within artifacts:

artifacts:
   kubernetes:
       - resource: artifacts/kubernetes/template.json
         params:
            foo:
               - /spec/template/metadata/foo
            bar:
               - /spec/template/metadata/bar
      - resource: artifacts/kubernetes/extra.json

dustymabe · 2016-03-14T23:18:51Z

@cdrage.. can we get a TL;DR for this? I'm not sure I follow everything.

dustymabe · 2016-04-01T14:25:31Z

ping @cdrage

cdrage · 2016-04-07T15:34:09Z

TLDR:

If you wish to change a value within a json/yaml file, you can specify the value and position in the file to replace, ex:

            param1:
                - /spec/containers/0/ports/0/hostPort
                - /spec/containers/0/ports/0/hostPort2

cdrage · 2016-06-06T12:34:55Z

@goern @aweiteka

Once #209 is merged, I can add this to the spec as it'll be easier to understand from a usability perspective on how to use this.

cdrage force-pushed the add-xpathing branch from 7a83d58 to 6b40166 Compare November 27, 2015 15:15

goern reviewed Dec 1, 2015
View reviewed changes

cdrage force-pushed the add-xpathing branch 2 times, most recently from 770a657 to 2205ddf Compare December 1, 2015 15:55

aweiteka reviewed Dec 2, 2015
View reviewed changes

cdrage force-pushed the add-xpathing branch from 2205ddf to f324e8e Compare December 17, 2015 16:30

cdrage changed the title ~~Implement XPathing to Nulecule spec.~~ Implement param pointers to Nulecule spec. Dec 21, 2015

cdrage force-pushed the master branch from f88dd67 to ae84b33 Compare December 22, 2015 16:07

cdrage force-pushed the add-xpathing branch 3 times, most recently from 8d8d453 to 73513e1 Compare December 22, 2015 16:27

Add JSON pointers to spec

beef97f

cdrage force-pushed the add-xpathing branch 2 times, most recently from 3d7c120 to beef97f Compare December 22, 2015 16:28

Describe param as structured data

4bccf24

Merge pull request #1 from aweiteka/cdrage-add-xpathing

bf36490

Describe param as structured data

cdrage added the feature label Mar 14, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement param pointers to Nulecule spec. #191

Implement param pointers to Nulecule spec. #191

cdrage commented Nov 27, 2015

goern Dec 1, 2015

cdrage Dec 1, 2015

goern commented Dec 1, 2015

aweiteka Dec 2, 2015

aweiteka commented Dec 2, 2015

cdrage commented Dec 2, 2015

cdrage commented Dec 17, 2015

cdrage commented Dec 21, 2015

aweiteka commented Dec 22, 2015

cdrage commented Dec 22, 2015

aweiteka commented Dec 22, 2015

aweiteka commented Dec 22, 2015

cdrage commented Jan 12, 2016

cdrage commented Feb 11, 2016

goern commented Feb 11, 2016

bexelbie commented Feb 12, 2016

cdrage commented Mar 14, 2016

dustymabe commented Mar 14, 2016

dustymabe commented Apr 1, 2016

cdrage commented Apr 7, 2016

cdrage commented Jun 6, 2016

Implement param pointers to Nulecule spec. #191

Are you sure you want to change the base?

Implement param pointers to Nulecule spec. #191

Conversation

cdrage commented Nov 27, 2015

goern Dec 1, 2015

Choose a reason for hiding this comment

cdrage Dec 1, 2015

Choose a reason for hiding this comment

goern commented Dec 1, 2015

aweiteka Dec 2, 2015

Choose a reason for hiding this comment

aweiteka commented Dec 2, 2015

cdrage commented Dec 2, 2015

cdrage commented Dec 17, 2015

cdrage commented Dec 21, 2015

aweiteka commented Dec 22, 2015

cdrage commented Dec 22, 2015

aweiteka commented Dec 22, 2015

aweiteka commented Dec 22, 2015

cdrage commented Jan 12, 2016

cdrage commented Feb 11, 2016

goern commented Feb 11, 2016

bexelbie commented Feb 12, 2016

cdrage commented Mar 14, 2016

dustymabe commented Mar 14, 2016

dustymabe commented Apr 1, 2016

cdrage commented Apr 7, 2016

cdrage commented Jun 6, 2016