Jira (PUP-5624) Properties (in resource types) should allow a read-only designation

[Reid Vandewiele (JIRA)]

Reid Vandewiele created an issue

Puppet / PUP-5624 Properties (in resource types) should allow a read-only designation Issue Type: Improvement Assignee: Unassigned Created: 2015/12/17 9:30 AM Priority: Normal Reporter: Reid Vandewiele Properties exist which are read-only. Examples include the "mtime" property of the File resource and the "power_state" property of the Vsphere_vm resource. Today, these read-only properties are implemented by making the validate method fail. This is a hack. In order to support better automatic documentation and validation there should exist a way to designate a property as read-only when defining them. A possible implementation would be a flag that can be passed when defining the property, similar to :array_matching. newproperty(:minute, :ready_only => true) A property defined as read-only should not need a custom validate function, and it should be possible to enumerate read-only properties for a type so as to separate them from read-write properties. This can be useful in auto documentation, pretty-print generation of Puppet code, or editing tools that integrate with Puppet's RAL. Add Comment

This message was sent by Atlassian JIRA (v6.4.12#64027-sha1:e3691cc)

[Henrik Lindberg (JIRA)]

Henrik Lindberg updated an issue

Puppet / PUP-5624 Properties (in resource types) should allow a read-only designation

Change By: Henrik Lindberg Labels: triaged

Add Comment

This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe)

[Henrik Lindberg (JIRA)]

Henrik Lindberg commented on PUP-5624

Re: Properties (in resource types) should allow a read-only designation Sounds like we could generalize parameters with an attribute that states in, out, or in_out. Ping David Lutterkort (discussion about API for types and providers).

Add Comment

[Henrik Lindberg (JIRA)]

Henrik Lindberg updated an issue

Puppet / PUP-5624

Properties (in resource types) should allow a read-only designation

Change By: Henrik Lindberg Component/s: Types and Providers

Add Comment

[David Lutterkort (JIRA)]

David Lutterkort commented on PUP-5624

Re: Properties (in resource types) should allow a read-only designation These sorts of designations make sense in general - the question is whether it is worth introducing them in the existing API, or if that should only be done in the new t&p API currently under design/discussion.

Add Comment

[Geoff Nichols (JIRA)]

Geoff Nichols updated an issue

Puppet / PUP-5624

Properties (in resource types) should allow a read-only designation

Change By: Geoff Nichols Team: Agent

Add Comment

[Geoff Nichols (JIRA)]

Geoff Nichols updated an issue

Puppet / PUP-5624 Properties (in resource types) should allow a read-only designation

Change By: Geoff Nichols Labels: needs_decision

Add Comment

[Adam Buxton (JIRA)]

Adam Buxton commented on PUP-5624

Re: Properties (in resource types) should allow a read-only designation David Schmitt Reid and the rest of the coherent thinking universe beat me too it Jeremy Adams too as of interest. As a personal opinion I think RO attributes should appear in the RAL code, but should be pre commented or flagged i.e file { '/path': ensure => file, #type => file, }

Add Comment

[David Schmitt (JIRA)]

David Schmitt commented on PUP-5624

Re: Properties (in resource types) should allow a read-only designation

David Lutterkort I like the idea for this to affect puppet resource output, and it would provide a venue to make the additional information in the Resource API useful to a wider audience (not only the developer).

Add Comment

[Jeremy Adams (JIRA)]

Jeremy Adams commented on PUP-5624

Re: Properties (in resource types) should allow a read-only designation

The approach suggested by Adam Buxton above for ((puppet resource}} would be a huge improvement for the new user trying to learn how to write DSL as it would keep them from trying to manage readonly attributes.

Add Comment

[David Lutterkort (JIRA)]

David Lutterkort commented on PUP-5624

Re: Properties (in resource types) should allow a read-only designation

I think this would be a nice addition to the output format, though I feel we need two different output formats: one, puppety + human-readable with niceties like outlined above, and one that's machine-readable that includes all attributes to give consumers the full view of a resource (while type => file is not something you want to cut and paste into a manifest, it's something that you'd want to store in a DB where you query resources)

Add Comment

[Adam Buxton (JIRA)]

Adam Buxton commented on PUP-5624

Re: Properties (in resource types) should allow a read-only designation

David Lutterkort I feel the above does both, the RAL when queried returns all available default attributes in human readable Puppet DSL which is effectively just machine readable JSON. The point of the request is to allow 'type=> file' and such attributes to be cut and pasted into a manifest as we see this is something users want to do, they want to know from a documentation stand point what the other attributes are, or were at the point the overwrote them. But today unless you have an in-depth knowledge of the resource, attributes it is a stumbling block to adoption of resources. IMHO i don't see any need or value in a second format just additional complexity and maintenance for us. if we wanted to take this to another level we possibly would highlight mandatory fields these are programmatically discoverable and the namevar too. (that's not a request just a thought) What we want to be able to succeed in doing is lower the barrier to entrys and adoption.

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Puppet / PUP-5624

Properties (in resource types) should allow a read-only designation

Change By: Josh Cooper

Properties exist which are read-only. Examples include the "mtime" property of the File resource and the "power_state" property of the Vsphere_vm resource. Today, these read-only properties are implemented by making the validate method fail. This is a hack.

In order to support better automatic documentation and validation there should exist a way to designate a property as read-only when defining them. A possible implementation would be a flag that can be passed when defining the property, similar to {{:array_matching}}. {code} newproperty(:minute, : ready_only read_only => true) {code}

A property defined as read-only should not need a custom validate function, and it should be possible to enumerate read-only properties for a type so as to separate them from read-write properties. This can be useful in auto documentation, pretty-print generation of Puppet code, or editing tools that integrate with Puppet's RAL.

Add Comment

This message was sent by Atlassian Jira (v8.5.2#805002-sha1:a66f935)