OpenStack - User contributions [en]

Meetings/Satori

2014-04-21T14:33:09Z

BK Box: /* Agenda for next meeting [2014-04-07] */

Meetings/Satori

2014-04-01T21:22:45Z

BK Box: /* Agenda for next meeting [2014-04-07] */

= Weekly Satori Team Meeting =

== Mission ==

The charter for the project is focused narrowly on discovering pre-existing infrastructure and installed or running software. For example, given a URL and some credentials, discover which server(s) the URL is hosted on, the topology of the infrastructure and what software is running on each server, as well as, pertinent settings for commonly encountered software like apache, varnish, and mysql.

== Coordinator ==

[[Ziad_Sawalha]] (zns on irc)

== When ==

If you're interested in Configuration Discovery in OpenStack, we hold public meetings weekly in <code><nowiki>#openstack-meeting-alt</nowiki></code>, on Monday at 15:00 UTC in freenode.

== Agenda for next meeting [2014-04-07] ==

Agenda items must be added by the previous Thursday along with a link to a wiki or document for attendees to be able to read up on and get context before the call on Monday:

- Review action items from previous meeting [standing item - we start each call with this]
- Discuss [https://blueprints.launchpad.net/satori/+spec/satori-discovery-schema Satori Schema proposal] [zns]

'''Please feel free to add items to the agenda below and we'll cover them.'''

- Discuss <strike>[https://blueprints.launchpad.net/satori/+spec/quiet-ssh Clean up SSH] output</strike> [https://bugs.launchpad.net/satori/+bug/1296983 SSH output bug] [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/share-ssh-connection Share SSH connection] for less noise and traffic [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/allow-custom-template Allow custom template] ( `--template-file output.jinja` ) [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/custom-systeminfo-plugin Allow local plugins] instead of built-in `--system-info` [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/ip-and-netloc-info Create `ip_info` and `netloc_info`] [gondoi]

== Previous meetings ==

Previous meetings, with their notes and logs, can be found under [[Satori/MeetingLogs]]

Meetings/Satori

2014-04-01T21:22:04Z

BK Box: /* Agenda for next meeting [2014-04-07] */

= Weekly Satori Team Meeting =

== Mission ==

The charter for the project is focused narrowly on discovering pre-existing infrastructure and installed or running software. For example, given a URL and some credentials, discover which server(s) the URL is hosted on, the topology of the infrastructure and what software is running on each server, as well as, pertinent settings for commonly encountered software like apache, varnish, and mysql.

== Coordinator ==

[[Ziad_Sawalha]] (zns on irc)

== When ==

If you're interested in Configuration Discovery in OpenStack, we hold public meetings weekly in <code><nowiki>#openstack-meeting-alt</nowiki></code>, on Monday at 15:00 UTC in freenode.

== Agenda for next meeting [2014-04-07] ==

Agenda items must be added by the previous Thursday along with a link to a wiki or document for attendees to be able to read up on and get context before the call on Monday:

- Review action items from previous meeting [standing item - we start each call with this]
- Discuss [https://blueprints.launchpad.net/satori/+spec/satori-discovery-schema Satori Schema proposal] [zns]

'''Please feel free to add items to the agenda below and we'll cover them.'''

- Discuss <strike>[https://blueprints.launchpad.net/satori/+spec/quiet-ssh Clean up SSH] output</strike> [https://bugs.launchpad.net/satori/+bug/1296983 SSH output] [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/share-ssh-connection Share SSH connection] for less noise and traffic [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/allow-custom-template Allow custom template] ( `--template-file output.jinja` ) [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/custom-systeminfo-plugin Allow local plugins] instead of built-in `--system-info` [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/ip-and-netloc-info Create `ip_info` and `netloc_info`] [gondoi]

== Previous meetings ==

Previous meetings, with their notes and logs, can be found under [[Satori/MeetingLogs]]

Meetings/Satori

2014-04-01T21:16:08Z

BK Box: /* Agenda for next meeting [2014-04-07] */

= Weekly Satori Team Meeting =

== Mission ==

The charter for the project is focused narrowly on discovering pre-existing infrastructure and installed or running software. For example, given a URL and some credentials, discover which server(s) the URL is hosted on, the topology of the infrastructure and what software is running on each server, as well as, pertinent settings for commonly encountered software like apache, varnish, and mysql.

== Coordinator ==

[[Ziad_Sawalha]] (zns on irc)

== When ==

If you're interested in Configuration Discovery in OpenStack, we hold public meetings weekly in <code><nowiki>#openstack-meeting-alt</nowiki></code>, on Monday at 15:00 UTC in freenode.

== Agenda for next meeting [2014-04-07] ==

Agenda items must be added by the previous Thursday along with a link to a wiki or document for attendees to be able to read up on and get context before the call on Monday:

- Review action items from previous meeting [standing item - we start each call with this]
- Discuss [https://blueprints.launchpad.net/satori/+spec/satori-discovery-schema Satori Schema proposal] [zns]

'''Please feel free to add items to the agenda below and we'll cover them.'''

- Discuss [https://blueprints.launchpad.net/satori/+spec/quiet-ssh Clean up SSH] output [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/share-ssh-connection Share SSH connection] for less noise and traffic [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/allow-custom-template Allow custom template] ( `--template-file output.jinja` ) [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/custom-systeminfo-plugin Allow local plugins] instead of built-in `--system-info` [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/ip-and-netloc-info Create `ip_info` and `netloc_info`] [gondoi]

== Previous meetings ==

Previous meetings, with their notes and logs, can be found under [[Satori/MeetingLogs]]

Meetings/Satori

2014-03-31T20:05:10Z

BK Box: /* Agenda for next meeting [2014-04-07] */

= Weekly Satori Team Meeting =

== Mission ==

The charter for the project is focused narrowly on discovering pre-existing infrastructure and installed or running software. For example, given a URL and some credentials, discover which server(s) the URL is hosted on, the topology of the infrastructure and what software is running on each server, as well as, pertinent settings for commonly encountered software like apache, varnish, and mysql.

== Coordinator ==

[[Ziad_Sawalha]] (zns on irc)

== When ==

If you're interested in Configuration Discovery in OpenStack, we hold public meetings weekly in <code><nowiki>#openstack-meeting-alt</nowiki></code>, on Monday at 15:00 UTC in freenode.

== Agenda for next meeting [2014-04-07] ==

Agenda items must be added by the previous Thursday along with a link to a wiki or document for attendees to be able to read up on and get context before the call on Monday:

- Review action items from previous meeting [standing item - we start each call with this]
- Discuss [https://blueprints.launchpad.net/satori/+spec/satori-discovery-schema Satori Schema proposal] [zns]

'''Please feel free to add items to the agenda below and we'll cover them.'''

- Discuss [https://blueprints.launchpad.net/satori/+spec/quiet-ssh Clean up SSH] output [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/share-ssh-connection Share SSH connection] for less noise and traffic [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/allow-custom-template Allow custom template] ( `--template-file output.jinja` ) [gondoi]
- Discuss [https://blueprints.launchpad.net/satori/+spec/custom-systeminfo-plugin Allow local plugins] instead of built-in `--system-info` [gondoi]

== Previous meetings ==

Previous meetings, with their notes and logs, can be found under [[Satori/MeetingLogs]]

Meetings/Satori

2014-03-31T15:14:41Z

BK Box: /* Agenda for next meeting [2014-03-31] */

Meetings/Satori

2014-03-31T13:46:23Z

BK Box: /* Agenda for next meeting [2014-03-31] */

Meetings/Satori

2014-03-31T13:46:01Z

BK Box: /* Agenda for next meeting [2014-03-24] */

Meetings/Satori

2014-03-24T14:29:14Z

BK Box: /* Agenda for next meeting [2014-03-17] */

Satori

2014-03-18T15:19:16Z

BK Box:

= OpenStack Configuration Discovery =

The charter for the project is focused narrowly on discovering pre-existing infrastructure and installed or running software. For example, given a URL and some credentials, discover which server(s) the URL is hosted on, the topology of the infrastructure and what software is running on each server, as well as, pertinent settings for commonly encountered software like apache, varnish, and mysql.

__TOC__

== Quick overview ==
* Source code https://github.com/stackforge/satori
* Feature tracker https://blueprints.launchpad.net/satori
* Bug tracker https://bugs.launchpad.net/satori/
* Developer doc http://satori.readthedocs.org/en/latest/

== Use Cases ==

We expect that the output of a configuration discovery tool could be used for:
* Troubleshooting unfamiliar environments
* Configuration analysis (compare the discovered state vs a library of best practices)
* System State Verification
* Detecting configuration changes over time
* Heat Template generation
* Solum Application creation/import
* Creation of Chef recipes/cookbooks, Puppet modules, Ansible playbooks, setup scripts, etc.

== Getting Started ==

The project will begin with a simple command-line tool so that new users can discover a configuration without needing to setup additional infrastructure. A mockup for the output is listed below:

$ satori discover www.foo.com

Address:
www.foo.com resolves to IPv4 address 4.4.4.4
Domain: foo.com
Registered at TUCOWS DOMAINS INC.
Expires in 475 days.
Name servers:
DNS1.STABLETRANSIT.COM
DNS2.STABLETRANSIT.COM
Host:
4.4.4.4 (www.foo.com) is hosted on a Nova Instance
Instance Information:
URI: https://nova.api.somecloud.com/v2/111222/servers/d9119040-f767-414
1-95a4-d4dbf452363a
Name: sampleserver01.foo.com
ID: d9119040-f767-4141-95a4-d4dbf452363a
ip-addresses:
public:
::ffff:404:404
4.4.4.4
private:
10.1.1.156
System Information:
Ubuntu 12.04 installed
Server was rebooted 11 days, 22 hours ago
/dev/xvda1 is using 9% of its inodes.
Running Services:
httpd on 127.0.0.1:8080
varnishd on 0.0.0.0:80
sshd on 0.0.0.0:22
httpd:
Using 7 of 100 MaxClients

== Initial Design Ideas ==

Though not yet proposed in Blueprints, these are some of the initial thoughts for the project to help guide discussion:

* A pluggable implementation to allow discovering:
** OpenStack infrastructure (instances, networks, et al.)
** Non-OpenStack Infrastructure (APIs for other clouds, nodes in a Chef server, vendor management interfaces)
** External infrastructure: DNS ownership and configuration, SSL Certificate validity, etc.
** Operating system and application configuration (See: [[Satori#Related_Work|Related Work]])
** Runtime information such as active processes and connections between systems.
* An API service for tenants to make discovery requests.
* A backend datastore to record the results of discoveries.

== Related Work ==
# [https://github.com/opscode/ohai Ohai]
# [https://github.com/puppetlabs/facter Facter]
# Ansible [https://github.com/ansible/ansible/blob/devel/library/system/setup#L101 facts.d/setup]
# Devstructure [https://github.com/devstructure/blueprint Blueprint]

== Satori Resources ==
* [https://launchpad.net/satori Satori on LaunchPad] (Blueprints, and bugs)
* [https://launchpad.net/~satori-drivers The Team (Join us!)]
* [https://github.com/stackforge/satori Source Code]
* [https://wiki.openstack.org/wiki/Satori/glossary Glossary]
* IRC: <code>#openstack-satori</code> on [http://freenode.net/ Freenode] for development discussion.
* [[Meetings/Satori|Weekly meeting schedule]], [[Satori/MeetingLogs|Previous meetings]]

Satori/AnsibleModuleProposal

2014-03-07T23:10:44Z

BK Box:

== Ansible Module Proposal ==

When running discovery, utilize [http://docs.ansible.com/ Ansible] if it's already available on the system.

==== Benefits ====

* It's written in Python so it's native (no shell-out)
* It has system info (facts) already built in with the `setup` [http://docs.ansible.com/intro_adhoc.html#gathering-facts module]
* It will run ohai and facter on the system to be discovered if [https://github.com/ansible/ansible/blob/devel/library/system/setup#L2307-L2336 already installed]
* We can create our own modules that live with the code or provide an option to look at a custom path

==== Deficiencies ====

* Each module has to be called individually
* Potentially "heavy" in terms of installation and execution (possibly negated by not directly requiring)
* Could open the door for changes instead of read-only

==== Interface ====

>>> from satori import ansible
>>> creds = {"username": "Tobias", "password": "pa$$word"}
>>> facts = ansible.discover(host, creds)

==== Implementation ====
* Import `satori.ansible` in a `try except` block to see if it is installed
* Simply require a `pip install ansible` to take advantage of it
* Allow a `-a` flag with an optional parameter of `--ansible-module-path` and/or `--ansible-module-name` for custom modules
* Do read only operations. This may only be allowable via the `setup` module execution _only_, and not allowing cutom modules yet.

Satori/AnsibleModuleProposal

2014-03-07T23:08:22Z

BK Box: Created page with "== Ansible Module Proposal == When running discovery, utilize [http://docs.ansible.com/ Ansible] if it's already available on the system. ==== Benefits ==== * It's written..."

== Ansible Module Proposal ==

When running discovery, utilize [http://docs.ansible.com/ Ansible] if it's already available on the system.

==== Benefits ====

* It's written in Python so it's native (no shell-out)
* It has system info (facts) already built in with the `setup` [http://docs.ansible.com/intro_adhoc.html#gathering-facts module]
* It will run ohai and facter on the system to be discovered if [https://github.com/ansible/ansible/blob/devel/library/system/setup#L2307-L2336 already installed]
* We can create our own modules that live with the code or provide an option to look at a custom path

==== Deficiencies ====

* Each module has to be called individually
* Potentially "heavy" in terms of installation and execution (possibly negated by not directly requiring)
* Could open the door for changes instead of read-only

==== Interface ====

>>>> from satori import ansible
>>>> creds = {"username": "Tobias", "password": "pa$$word"}
>>>> facts = ansible.discover(host, creds)

==== Implementation ====
* Import `satori.ansible` in a `try except` block to see if it is installed
* Simply require a `pip install ansible` to take advantage of it
* Allow a `-a` flag with an optional parameter of `--ansible-module-path` and/or `--ansible-module-name` for custom modules
* Do read only operations. This may only be allowable via the `setup` module execution _only_, and not allowing cutom modules yet.

Satori

2014-01-29T21:58:25Z

BK Box: /* Satori Resources */

= OpenStack Configuration Discovery =

The charter for the project is focused narrowly on discovering pre-existing infrastructure and installed or running software. For example, given a URL and some credentials, discover which server(s) the URL is hosted on, the topology of the infrastructure and what software is running on each server, as well as, pertinent settings for commonly encountered software like apache, varnish, and mysql.

__TOC__

== Use Cases ==

We expect that the output of a configuration discovery tool could be used for:
* Troubleshooting unfamiliar environments
* Configuration analysis (compare the discovered state vs a library of best practices)
* System State Verification
* Detecting configuration changes over time
* Heat Template generation
* Solum Application creation/import
* Creation of Chef recipes/cookbooks, Puppet modules, Ansible playbooks, setup scripts, etc.

== Getting Started ==

The project will begin with a simple command-line tool so that new users can discover a configuration without needing to setup additional infrastructure. A mockup for the output is listed below:

$ satori discover www.foo.com
Domain: foo.com
Registered at TUCOWS DOMAINS INC.
Expires in 475 days.
Name servers:
DNS1.STABLETRANSIT.COM
DNS2.STABLETRANSIT.COM
Address:
www.foo.com resolves to IPv4 address 4.4.4.4
Host:
4.4.4.4 (www.foo.com) is hosted on a Nova Instance
Instance Information:
URI: https://nova.api.somecloud.com/v2/111222/servers/d9119040-f767-414
1-95a4-d4dbf452363a
Name: sampleserver01.foo.com
ID: d9119040-f767-4141-95a4-d4dbf452363a
ip-addresses:
public:
::ffff:404:404
4.4.4.4
private:
10.1.1.156
System Information:
Ubuntu 12.04 installed
Server was rebooted 11 days, 22 hours ago
/dev/xvda1 is using 9% of its inodes.
Running Services:
httpd on 127.0.0.1:8080
varnishd on 0.0.0.0:80
sshd on 0.0.0.0:22
httpd:
Using 7 of 100 MaxClients

== Initial Design Ideas ==

Though not yet proposed in Blueprints, these are some of the initial thoughts for the project to help guide discussion:

* A pluggable implementation to allow discovering:
** OpenStack infrastructure (instances, networks, et al.)
** Non-OpenStack Infrastructure (APIs for other clouds, nodes in a Chef server, vendor management interfaces)
** External infrastructure: DNS ownership and configuration, SSL Certificate validity, etc.
** Operating system and application configuration (See: [[Satori#Related_Work|Related Work]])
** Runtime information such as active processes and connections between systems.
* An API service for tenants to make discovery requests.
* A backend datastore to record the results of discoveries.

== Related Work ==
# [https://github.com/opscode/ohai Ohai]
# [https://github.com/puppetlabs/facter Facter]
# Ansible [https://github.com/ansible/ansible/blob/devel/library/system/setup#L101 facts.d/setup]
# Devstructure [https://github.com/devstructure/blueprint Blueprint]

== Satori Resources ==
* [https://launchpad.net/satori Satori on LaunchPad] (Blueprints, and bugs)
* [https://launchpad.net/~satori-drivers The Team (Join us!)]
* [https://github.com/rackerlabs/satori Source Code] (to be moved to Stackforge soon)
* IRC: <code>#satori</code> on [http://freenode.net/ Freenode] for development discussion.