summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md59
1 files changed, 55 insertions, 4 deletions
diff --git a/README.md b/README.md
index 94dbc88..3fb06e3 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
# Oxidized [![Build Status](https://travis-ci.org/Shopify/oxidized.svg)](https://travis-ci.org/Shopify/oxidized) [![Gem Version](https://badge.fury.io/rb/oxidized.svg)](http://badge.fury.io/rb/oxidized) [![Join the chat at https://gitter.im/oxidized/Lobby](https://badges.gitter.im/oxidized/Lobby.svg)](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+** Is your company using Oxidized and has Ruby developers on staff? I'd love help from an extra maintainer!**
+
+[WANTED: MAINTAINER](#help-needed)
+
Oxidized is a network device configuration backup tool. It's a RANCID replacement!
* automatically adds/removes threads to meet configured retrieval interval
@@ -66,6 +70,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
* [C4CMTS](lib/oxidized/model/c4cmts.rb)
* Aruba
* [AOSW](lib/oxidized/model/aosw.rb)
+ * AudioCodes
+ * [AudioCodes](lib/oxdized/model/audiocodes.rb)
* Avaya
* [VOSS (VSP Operating System Software)](lib/oxidized/model/voss.rb)
* [BOSS (Baystack Operating System Software)](lib/oxidized/model/boss.rb)
@@ -84,12 +90,15 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
* Cisco
* [AireOS](lib/oxidized/model/aireos.rb)
* [ASA](lib/oxidized/model/asa.rb)
+ * [AsyncOS](lib/oxidized/model/asyncos.rb)
* [CatOS](lib/oxidized/model/catos.rb)
* [IOS](lib/oxidized/model/ios.rb)
* [IOSXR](lib/oxidized/model/iosxr.rb)
* [NGA](lib/oxidized/model/cisconga.rb)
* [NXOS](lib/oxidized/model/nxos.rb)
+ * [SMA](lib/oxidized/model/ciscosma.rb)
* [SMB (Nikola series)](lib/oxidized/model/ciscosmb.rb)
+ * [UCS](lib/oxidized/model/ucs.rb)
* Citrix
* [NetScaler (Virtual Applicance)](lib/oxidized/model/netscaler.rb)
* Coriant (former Tellabs)
@@ -99,6 +108,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
* [Linux](lib/oxidized/model/cumulus.rb)
* DataCom
* [DmSwitch 3000](lib/oxidized/model/datacom.rb)
+ * DCN
+ * [DCN](lib/oxidized/model/ios.rb) - Map this to ios.
* DELL
* [PowerConnect](lib/oxidized/model/powerconnect.rb)
* [AOSW](lib/oxidized/model/aosw.rb)
@@ -107,8 +118,9 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
* Ericsson/Redback
* [IPOS (former SEOS)](lib/oxidized/model/ipos.rb)
* Extreme Networks
- * [XOS](lib/oxidized/model/xos.rb)
+ * [Enterasys](/lib/oxidized/model/enterasys.rb)
* [WM](lib/oxidized/model/mtrlrfs.rb)
+ * [XOS](lib/oxidized/model/xos.rb)
* F5
* [TMOS](lib/oxidized/model/tmos.rb)
* Force10
@@ -126,6 +138,7 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
* [Comware (HP A-series, H3C, 3Com)](lib/oxidized/model/comware.rb)
* [Procurve](lib/oxidized/model/procurve.rb)
* [BladeSystem (Onboard Administrator)](lib/oxidized/model/hpebladesystem.rb)
+ * [MSA](lib/oxidized/model/hpemsa.rb)
* Huawei
* [VRP](lib/oxidized/model/vrp.rb)
* Juniper
@@ -155,6 +168,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
* [PANOS](lib/oxidized/model/panos.rb)
* [PLANET SG/SGS Switches](lib/oxidized/model/planet.rb)
* [pfSense](lib/oxidized/model/pfsense.rb)
+ * Radware
+ * [AlteonOS](lib/oxidized/model/alteonos.rb)
* Quanta
* [Quanta / VxWorks 6.6 (1.1.0.8)](lib/oxidized/model/quantaos.rb)
* Siklu
@@ -171,6 +186,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
* [EdgeSwitch](lib/oxidized/model/edgeswitch.rb)
* Watchguard
* [Fireware OS](lib/oxidized/model/firewareos.rb)
+ * Westell
+ * [Westell 8178G, Westell 8266G](lib/oxidized/model/weos.rb)
* Zhone
* [Zhone (OLT and MX)](lib/oxidized/model/zhoneolt.rb)
* Zyxel
@@ -1012,6 +1029,9 @@ hooks:
channel: "#network-changes"
```
+Note the channel name must be in quotes.
+
+
# Extra
## Ubuntu SystemV init setup
@@ -1037,11 +1057,9 @@ chown oxidized:oxidized /var/run/oxidized
3.)Make oxidized start on boot
```
-update-rc.d oxidized deafults
+update-rc.d oxidized defaults
```
-Note the channel name must be in quotes.
-
# Ruby API
The following objects exist in Oxidized.
@@ -1075,6 +1093,39 @@ The following objects exist in Oxidized.
* 'junos', 'ios', 'ironware' and 'powerconnect' implemented
+# Help Needed
+
+As things stand right now, `oxidized` is maintained by a single person. A great
+many [contributors](https://github.com/ytti/oxidized/graphs/contributors) have
+helped further the software, however contributions are not the same as ongoing
+owner- and maintainership. It appears that many companies use the software to
+manage their network infrastructure, this is great news! But without additional
+help to maintain the software and put out releases, the future of oxidized
+might be less bright. The current pace of development and the much needed
+refactoring simply are not sustainable if they are to be driven by a single
+person.
+
+## Maintainer duties and expectations
+
+* 4 hours per week to perform triage on issues, review pull requests and help answer any questions from users.
+* Above average knowledge of the Ruby programming language.
+* Professional experience with both oxidized and some other config backup tool (like rancid).
+* Ability to keep a cool head, and enjoy interaction with end users! :)
+* A desire and passion to help drive `oxidized` towards its `1.x.x` stage of life
+ * help refactor the code
+ * rework the core infrastructure
+* Permission from your employer to contribute to open source projects
+
+## YES, I WANT TO HELP
+
+Awesome! Simply send an email to Saku Ytti <saku@ytti.fi>.
+
+## Further reading
+
+Brian Anderson (from Rust fame) wrote an [excellent
+post](http://brson.github.io/2017/04/05/minimally-nice-maintainer) on what it
+means to be a maintainer.
+
# License and Copyright
Copyright 2013-2015 Saku Ytti <saku@ytti.fi>