Project

General

Profile

Actions

User story #4420

closed

NCF documentation

Added by Dennis Cabooter about 10 years ago. Updated over 8 years ago.

Status:
Rejected
Priority:
2
Category:
Documentation
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

I know NCF is in Rudder 2.9. However, I don't know how to use it, because there's not much documentation. I heard that in Rudder 2.10 it will be possible to create techniques from the web interface. However, I really would like to know hope NCF works and I would like to have some documentation. Of course it's no problem for me to help with that.

At the moment I only use a few techniques for everything I do with Rudder on all servers and desktops. I would love to build my own techniques with predefined blocks. Some techniques are just too limited, no offence. Example, the OpenSSH technique. I can't use it, because not all configuration options I need are covered. For me the solution is to use multiple other directives to do the job.

It's not a problem, because writing promises with Rudder is many times faster than writing CFengine promises by hand. But I think techniques could be more flexible. If I need just one option in sshd_config and it's not in the OpenSSH technique, I can't use the technique. Or when I don't have the option in the stab technique to mount the added file systems, I can't use the technique, because I can't reboot nodes and I don't want to mount the file systems manually.

I hope my comments are useful. Keep up the good work! :-)


Related issues 1 (0 open1 closed)

Related to Rudder - Bug #6305: Add a section about ncf-builder and its integration wihin RudderReleasedFrançois ARMAND2015-02-27Actions
Actions #1

Updated by Matthieu CERDA about 10 years ago

  • Category set to Documentation
  • Status changed from New to Discussion
  • Assignee set to Vincent MEMBRÉ
  • Priority changed from N/A to 2
  • Target version set to Ideas (not version specific)

Hello Dennis.

I know for sure that Vincent is at this very moment seeking for a nice way of documenting ncf, can you confirm Vince ?

Actions #2

Updated by Vincent MEMBRÉ about 10 years ago

That is in progress ;)

A website should be available soon, explaining how it works, its philosophy, and documentation about all bundles from ncf (autogenerated à la javadoc), examples, ... !

Do you have any ideas, of what would be cool to see in it ??

Actions #3

Updated by Jonathan CLARKE about 10 years ago

Yes, the ncf website is still work in progress, but already available on http://www.ncf-project.org/.

This only includes documentation for using ncf. I will also write a document to explain how to integrate ncf into Rudder.

Actions #4

Updated by Jonathan CLARKE about 10 years ago

  • Assignee changed from Vincent MEMBRÉ to Jonathan CLARKE
Actions #5

Updated by Benoît PECCATTE almost 9 years ago

  • Assignee changed from Jonathan CLARKE to Vincent MEMBRÉ

Vincent, there is a documentation now isn't it ?

Actions #6

Updated by Alexis Mousset over 8 years ago

  • Related to Bug #6305: Add a section about ncf-builder and its integration wihin Rudder added
Actions #7

Updated by Alexis Mousset over 8 years ago

  • Status changed from Discussion to Rejected

Closing, ncf now has a website (http://www.ncf.io/) and the Rudder manual includes a section about the Technique Editor.

Actions

Also available in: Atom PDF