...

This section describes how to use the user-defined playbooks and the pre-built playbooks.

How to Use the User-defined Playbooks

Add/Edit a Playbook

Step 1        Add a playbook.

...

   NOTE: When the playbook is deleted, the related jobs and task results will also be removed.

Save As a Playbook (version control)

Click "Save As" button in the playbook table to create a copy of the current playbook. This function can be used to back up the playbook or to create a different version of the playbook.

The playbook name field will be automatically filled with current playbook name plus with current daytime. User can also rename the new copy playbook.

Export / Import a Playbook

AmpCon supports to export and import a playbook, the following procedure shows how to export or import a playbook:

...

   NOTE: The entered playbook name should be unique.

Run a Playbook

When running Ansible playbooks, AmpCon executes the defined tasks in file playbook.yml on the targeted switches. This section describes how to run the Ansible playbooks.

...

How to Use the Pre-built Playbooks

1.  Support to show the pre-built internal playbooks in “Automation” -> “Playbooks”.By default, it will not show the internal pre-built playbooks in playbook list.

Image Removed

User      User can enable “Show Internal Playbook” to check the internal pre-built playbooks.

Image Added

The pre-built playbooks will have a badge “Internal” after the playbook name.

2.   For normal playbooks, we support “Edit” Pre-built internal playbooks support “View”, “Save As”, “Run”, “Export” , “Remove” actions in “Operation” column.

Image Removed

For pre-built internal playbooks, we only support “View”, “Save As”, “Export”.

We will not support to “Edit”, “Run” and “Remove” the pre-built internal playbooks.

3.   We support to  Users can update the latest pre-installed built playbooks from Gitlab by clicking “Update Internal Playbooks” the button “Update Internal Playbooks” (https://github.com/pica8/playbook).

4.   Workflows for using internal playbooks.

a. Update the latest pre-built internal playbooks.

b. Select the example pre-built internal playbooks, click “Save As” to save user own snapshot of the playbook.

          c. Edit the snapshot playbook files if necessary.

d. Click “Run” to schedule a task to run this playbook.

 Notices: We do not support to run the pre-built internal playbooks; user can just save their own versions to run it instead.

5.   Tasks need to be done in Github repository. (https://github.com/pica8/playbook)

1. 1. Determine which playbooks should be involved in the repository.
   2. Update the repository to make the folder structure can be resolved by AmpCon code.

6.   Task need to be done when provide hypervisor image [OVA / OVF / QCOW2]

1. 1. Package with default playbooks.
   2. Create responding records

7.   Tasks need to be done in AmpCon upgrade:

1. 1. Package with default playbooks.
   2. Create responding records