Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added some docs

  • Loading branch information...
commit ef350a1a94511ca74418520cd1453d58c24f7ebb 1 parent c1885ca
Tim Sharpe authored
View
2  .gitignore
@@ -0,0 +1,2 @@
+docs/*.3
+docs/*.3.html
View
114 docs/ha_crm_primitive.3.ronn
@@ -0,0 +1,114 @@
+ha_crm_primitive(3) - Manage cluster primitives (resources)
+===========================================================
+
+## SYNOPSIS
+
+ ha_crm_primitive { "<primitive name>":
+ type => "<class>:<provider>:<type>"
+ ensure => "(present|absent)",
+ only_run_on_dc => "(true|false)",
+ priority => "<integer>",
+ target_role => "(stopped|started|master)",
+ is_managed => "(true|false)",
+ resource_stickiness => "<integer>",
+ migration_threshold => "<integer>",
+ failure_timeout => "<integer>",
+ multiple_active => "(block|stop_only|stop_start)",
+ }
+
+## DESCRIPTION
+
+A cluster primitive or resource is anything that is managed by the cluster,
+from a service such as MySQL, to a filesystem mount, to a floating IP
+address. This type allows you to define these resources inside your Puppet
+manifest.
+
+## REQUIRED PARAMETERS
+
+ * `name var`:
+ The name of the primitive (used as a reference for most other ha:: types)
+
+ Allowed values: `.+`
+
+ * `type`:
+ The primitive class (almost always will start with ocf: or lsb:)
+
+ Allowed values: `.+`
+
+ * `ensure`:
+ Whether this primitive should exist in the CIB
+
+ Allowed values: `absent`, `present`
+
+## OPTIONAL PARAMETERS
+
+ * `only_run_on_dc`:
+ Should Puppet only attempt to manage this resource if the node is the cluster DC
+
+ Allowed values: `true`, `false`
+
+ Default value: `true`
+ * `priority`:
+ The priority of the resource
+
+ Allowed values: `\d+`
+
+ Default value: 0
+ * `target_role`:
+ What state should the cluster attempt to keep this resource in?
+
+ Allowed values: `started`, `stopped`, `master`
+
+ Default value: `started`
+ * `is_managed`:
+ Is the cluster allowed to start and stop the resource?
+
+ Allowed values: `true`, `false`
+
+ Default value: `true`
+ * `resource_stickiness`:
+ How much does the resource prefer to stay where it is?
+
+ Allowed values: `\d+`
+
+ Default value: `inherited from default-resource-stickiness property`
+ * `migration_threshold`:
+ How many failures should occur for this resource on a node before making the node ineligible to host this resource.
+
+ Allowed values: `\d+`
+
+ Default value: `0`
+ * `failure_timeout`:
+ How many seconds to wait before acting as if the failure had not occurred
+
+ Allowed values: `\d+`
+
+ Default value: `0`
+ * `multiple_active`:
+ What should the cluster do if it ever finds the resource active on more than one node
+
+ Allowed values: `block`, `stop_only`, `stop_start`
+
+ Default value: `stop_start`
+
+## EXAMPLES
+
+A MySQL server:
+ ha_crm_primitive { "mysql-server":
+ type => "lsb:mysqld",
+ ensure => present,
+ }
+
+A filesystem mount:
+ ha_crm_primitve { "fs_mysql":
+ type => "ocf:heartbeat:Filesystem",
+ ensure => present,
+ }
+
+## COPYRIGHT
+
+This Puppet HA module is Copyright (C) 2010 Tim Sharpe <tim@sharpe.id.au>
+
+## SEE ALSO
+
+[ha_crm_property(3)](http://bombasticmonkey.com/puppet-ha/ha_crm_property.3)
View
61 docs/ha_crm_property.3.ronn
@@ -0,0 +1,61 @@
+ha_crm_property(3) - Set a cluster-wide (crm_config) property
+=============================================================
+
+## SYNOPSIS
+
+ ha_crm_property { "<property name>":
+ value => "<value>",
+ ensure => "(present|absent)",
+ only_run_on_dc => "(true|false)",
+ }
+
+## DESCRIPTION
+
+Cluster options, as you'd expect, control how the cluster behaves when
+confronted with certain situations. This type allows you to manage the
+cluster options via your Puppet manifest.
+
+## REQUIRED PARAMETERS
+
+ * `name var`:
+ The name of the cluster property that you wish to adjust.
+
+ Allowed values: `.*`
+ * `value`:
+ The value that you wish to assign to the cluster property.
+
+ Allowed values: `.*`
+ * `ensure`:
+ The existential state that this property should be in.
+
+ Allowed values: `absent`, `present`
+ * `only_run_on_dc`:
+ Should we only attempt to change the value of this property if we're
+ the cluster DC (Designated Controller). In general, you'll want to leave
+ this at it's default value `true`
+
+ Allowed values: `true`, `false`
+
+ Default value: `true`
+
+## EXAMPLES
+
+Enable STONITH:
+ ha_crm_property { "stonith-enabled":
+ value => "true",
+ ensure => present,
+ }
+
+Unmanage all the resources:
+ ha_crm_property { "is-managed-default":
+ value => "false",
+ ensure => present,
+ }
+
+## COPYRIGHT
+
+This Puppet HA module is Copyright (C) 2010 Tim Sharpe <tim@sharpe.id.au>
+
+## SEE ALSO
+
+[ha_crm_primitive(3)](http://bombasticmonkey.com/puppet-ha/ha_crm_primitive.3)
Please sign in to comment.
Something went wrong with that request. Please try again.