Documentation
¶
Index ¶
- func ExampleCommand()
- func ExampleCommandInventory()
- func ExampleCommandNotRequired()
- func ExampleCommandWithArgs()
- func ExampleCommandWithBecome()
- func ExampleCommandWithChdir()
- func ExampleInventory()
- func ExampleInventoryGroupArgs()
- func ExampleInventoryWithConcurrency()
- func ExampleInventoryWithGroups()
- func ExampleNode()
- func ExampleNodeConnect()
- func ExampleNodeWithConfig()
- func ExampleSkillFluent()
- func ExampleSkillMixedChaining()
- func ExampleSkillWithArgs()
- func NewExamplePlaybook() types.RunnableInterface
- type ExamplePlaybook
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExampleCommand ¶ added in v0.15.0
func ExampleCommand()
ExampleCommand demonstrates using CommandInterface which implements RunnableInterface to run on nodes and inventories.
func ExampleCommandInventory ¶ added in v0.15.0
func ExampleCommandInventory()
ExampleCommandInventory demonstrates running commands on an inventory (multiple nodes).
func ExampleCommandNotRequired ¶ added in v0.15.0
func ExampleCommandNotRequired()
ExampleCommandNotRequired demonstrates using WithRequired(false) to allow execution to continue even if the command fails.
func ExampleCommandWithArgs ¶ added in v0.15.0
func ExampleCommandWithArgs()
ExampleCommandWithArgs demonstrates that commands can use args like other runnables.
func ExampleCommandWithBecome ¶ added in v0.15.0
func ExampleCommandWithBecome()
ExampleCommandWithBecome demonstrates using WithBecomeUser to run commands as a different user (e.g., postgres, www-data).
func ExampleCommandWithChdir ¶ added in v0.15.0
func ExampleCommandWithChdir()
ExampleCommandWithChdir demonstrates using WithChdir to run commands in a specific working directory.
func ExampleInventory ¶ added in v0.16.0
func ExampleInventory()
ExampleInventory demonstrates creating an inventory with multiple groups. This shows how to organize nodes into logical groups for bulk operations.
func ExampleInventoryGroupArgs ¶ added in v0.16.0
func ExampleInventoryGroupArgs()
ExampleInventoryGroupArgs demonstrates group argument inheritance.
func ExampleInventoryWithConcurrency ¶ added in v0.16.0
func ExampleInventoryWithConcurrency()
ExampleInventoryWithConcurrency demonstrates setting concurrency for parallel execution.
func ExampleInventoryWithGroups ¶ added in v0.16.0
func ExampleInventoryWithGroups()
ExampleInventoryWithGroups demonstrates running operations on specific groups.
func ExampleNode ¶ added in v0.16.0
func ExampleNode()
ExampleNode demonstrates using nodes with fluent configuration. This shows how to configure and use nodes for remote operations.
func ExampleNodeConnect ¶ added in v0.16.0
func ExampleNodeConnect()
ExampleNodeConnect demonstrates persistent SSH connections.
func ExampleNodeWithConfig ¶ added in v0.16.0
func ExampleNodeWithConfig()
ExampleNodeWithConfig demonstrates using node configuration.
func ExampleSkillFluent ¶ added in v0.16.0
func ExampleSkillFluent()
ExampleSkillFluent demonstrates using skills with fluent With* chaining. This shows how to configure skills using the fluent interface pattern.
func ExampleSkillMixedChaining ¶ added in v0.16.0
func ExampleSkillMixedChaining()
ExampleSkillMixedChaining demonstrates using fluent With* methods.
func ExampleSkillWithArgs ¶ added in v0.16.0
func ExampleSkillWithArgs()
ExampleSkillWithArgs demonstrates configuring skills with arguments.
func NewExamplePlaybook ¶
func NewExamplePlaybook() types.RunnableInterface
NewExamplePlaybook creates a new example playbook.
Types ¶
type ExamplePlaybook ¶
type ExamplePlaybook struct {
*types.BasePlaybook
}
ExamplePlaybook demonstrates a basic playbook that runs multiple skills in sequence. This playbook checks system status and updates if needed.
func (*ExamplePlaybook) Run ¶
func (e *ExamplePlaybook) Run() types.Result
Run executes the playbook with custom orchestration logic.
Source Files