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

Fixes #8755: Document node properties #209

Conversation

peckpeck
Copy link
Member


----

${node.properties[mykey]}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use real-life examples wherever possible. "datacenter=Paris" is a good example (here, just replace "mykey" by "datacenter" twice)

@peckpeck
Copy link
Member Author

Commit modified

@peckpeck peckpeck force-pushed the ust_8755/document_node_properties branch from 2d0c296 to 04f588f Compare July 26, 2016 15:23

Node properties can be found in the "properties" tab of each node in Rudder.

Node properties can be modified using Rudder API, see http://www.rudder-project.org/rudder-api-doc/#api-Nodes-updateNodeProperties
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this appear as a link when the docs are built?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If not, please make it a link.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cannot generate the doc at the moment, but it seems to work for other links in the documentation.

@peckpeck
Copy link
Member Author

Commit modified

@peckpeck peckpeck force-pushed the ust_8755/document_node_properties branch from 04f588f to 8707c30 Compare July 27, 2016 09:04

----

WARNING: currently node properties can not be used inside ${eval } JavaScript blocks, since they are evaluated during poliocy generation and node properties are only made available in the agents. A workaround for this will be provided in a future version of Rudder.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, I made a typo, sorry: s/poliocy/policy/

@jooooooon
Copy link
Member

This looks good to me apart from that one typo. Please fix and self-merge.

@peckpeck
Copy link
Member Author

Commit modified

@Normation-Quality-Assistant
Copy link
Contributor

OK, merging this PR

@Normation-Quality-Assistant Normation-Quality-Assistant merged commit d926ab4 into Normation:branches/rudder/3.1 Jul 27, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants