choria-io / website Goto Github PK

related to choria-legacy/mcollective-choria#590

I've tried to start building my own Choria agent, to send some commands to a simple executable service.
The extending Choria section was good, but many important other information was spread across different sections. e.g. like packaging process.

It would be good to have a "getting started" guide for developing:

• Needed / recommended tools (Choria mco, building packages, pdk and other plugins)
• What is the right layout for my module (with agents, applications etc)
• Do I need a client if I've an agent

Additional ideas:

• the code example are somewhere on github as complete module / working code (and not only parts of the code in the how to)
• guide: should I develop an agent, application or use a simple shell command?

• create master.choria.io to test
• setup ssl on master
• test redirects for nats and schemas on master
• move dev.choria.io
• create site for choria.io
• update rake file to generate correct urls
• set up dns for choria.io
• set up SSL for choria.io
• retire surge and ensure billing is stopped

The website give sample output of commands which was generated on old infrastructures. Beside the version numbers which are from another age, some command output has changed a bit, and paths have been updated.

I currently only have FreeBSD nodes with quite custom paths, so I will provide up-to-date example when I have access to a Linux machine with the Puppet AIO packages installed on it.

fyi.

The roadmap link at the bottom of http://choria.io/docs/playbooks/ is broken.

On http://choria.io/docs/federation/configuration/

Once this setting is present it will become a Federated Client and use the _mcollective-federation_server._tcp SRV record or plugin.choria.federated_middleware_hosts configuration entry.

It should be "federation_middleware_hosts", not "federated_middleware_hosts".

Using something like https://rnelson0.com/2017/12/07/self-documenting-puppet-modules-with-puppet-strings/, generate "API" docs for choria functions / plans.