Differences

This shows you the differences between two versions of the page.

--- linux_wiki:ansible-pull [2018/07/20 23:31]
billdozor created
+++ linux_wiki:ansible-pull [2019/05/25 23:50] (current)
@@ Line 25: / Line 25: @@
 The entire role directory structure/files can remain the same as if it were being deployed via normal ansible-playbook commands.
+===== Playbook: Directory Stucture =====
+The directory structure for an Ansible Pull repo does not look that much different than Ansible's best practices for playbooks.
+If this method is followed, the same role can also be used on the system that does regular ansible-playbook push commands (referenced from a different playbook file).
+<code bash>
+├── myplaybook.yml
+└── myrole
+    ├── files
+    ├── handlers
+    │   └── main.yml
+    ├── tasks
+    │   └── main.yml
+    └── vars
+        └── main.yml
+</code>
+----
 ===== Playbook: Example =====
 Example of a playbook tailored for pulling.
-<code bash>
+<code yaml>
+# File: myplaybook.yml
+# Description: Playbook used to execute on the local system via ansible-pull
+# hosts to run on
+- hosts:
+    - localhost
+  # roles: located in same directory
+  roles:
+    # role: role to assign to hosts, tags: tag(s) to give entire role
+    - { role: myrole, tags: myrole }
+  # Do not gather host facts for this playbook (comment out/remove if you need facts)
+  gather_facts: no
 </code>
@@ Line 35: / Line 69: @@
 Example of a role that can be used with either a pull playbook or normal playbook.
-<code bash></code>
+\\
+File: myrole/tasks/main.yml  -> Installs a list of applications using the variable "my_awesome_apps" and notifies a handler if anything changes
+<code yaml>
+- name: Install my awesome app list
+  yum:
+    name: "{{ my_awesome_apps }}"
+    state: present
+  notify: restart my awesome service
+</code>
+\\
+File: myrole/vars/main.yml  -> Variable that contains a list of applications to install
+<code yaml>
+my_awesome_apps:
+ - myapp1
+ - myapp2
+</code>
+\\
+File: myrole/vars/handlers.yml  -> Handler that restarts a service when triggered
+<code yaml>
+- name: restart my awesome service
+  service:
+    name: my-awesome-service
+    state: restarted
+</code>
 ----
 ====== The Client: Putting It All Together ======
+Steps for the client to run the playbook via ansible-pull.
+Example with a git repo
+  * Install ansible and git<code bash>yum -y install ansible git</code>
+  * **If Using SSH Key Login**
+    * Copy private ssh key to root's .ssh directory<code bash>cp /mnt/remote-mount/share/id_rsa_ansible-pull /root/.ssh/id_rsa_ansible-pull</code>
+    * Ensure proper permissions<code bash>chown root:root /root/.ssh/id_rsa_ansible-pull
+chmod 600 /root/.ssh/id_rsa_ansible-pull</code>
+  * Create a directory for ansible-pull to clone into<code bash>mkdir -p /root/.ansible/pull</code>
+  * Run the ansible-pull command
+    * **SSH Key Example**<code bash>ansible-pull --directory /root/.ansible/pull --url git@mygitserver.mycorps.domain.org:group/myrepo.git --key-file /root/.ssh/id_rsa_ansible-pull --accept-host-key --clean myplaybook.yml</code>
+    * **HTTPS Example**<code bash>ansible-pull --directory /root/.ansible/pull --url https://mygitserver.mycorps.domain.org/group/myrepo.git --clean myplaybook.yml</code>
+Options Used
+  * --directory  -> Use this directory to checkout/clone repo to
+  * --url  -> SSH or HTTPS url to clone from
+  * --key-file  -> Use this private ssh key (ssh method)
+  * --accept-host-key  -> Auto add the host identification for the url if not added (ssh method)
+  * --clean  -> Files modified in the local copy of the repo are discarded
+  * myplaybook.yml  -> Playbook to execute in the repo
+----
+====== Beyond: Continuous Deployment ======
+Using ansible-pull, there is now the capability to make changes to systems via repo pushes.
+Automation Ideas
+  * Create a cron that runs an ansible-pull script
+    * The script could provide logging for ansible-pull command output
+    * Have the cron run frequently enough to pick up changes fast (every 15 minutes or so)
+  * Add an argument to the ansible-pull command to only execute if the remote repo has been updated<code bash>--only-if-changed</code>
+  * Create a branch for each type of environment systems are in.
+    * Examples:
+      * Unstable
+      * Development
+      * Testing
+      * Production
+    * Add protection to Development, Testing, and Production to force merge requests (peer review) prior to updates being pushed.
+    * Use Unstable to test changes to a small group of systems
+  * Add an argument to the ansible-pull command to include the branch name for each environment. Development branch example<code bash>--checkout 'development'</code>
 ----