Chapter 2. Creating a playbook with modules from Satellite Ansible Collection

Procedure

1. Store your sensitive variables in an encrypted file:

   1. Create an Ansible vault. For example, to create a vault named My_Vault.yml:

      $ ansible-vault create My_Vault.yml

      Copy to Clipboard Toggle word wrap

   2. After the ansible-vault create command opens an editor, provide the required parameters in the key: value format.

      If you want to authenticate with Satellite username and password:

      My_Username: My_Admin_User_Account
      My_Password: My_Admin_Password
      My_Server_URL: https://satellite.example.com

      Copy to Clipboard Toggle word wrap

      If you want to authenticate with Satellite username and Personal Access Token (PAT):

      My_Username: My_Admin_User_Account
      My_Password: My_PAT
      My_Server_URL: https://satellite.example.com

      Copy to Clipboard Toggle word wrap

      If you want to authenticate with a Kerberos ticket:

      My_Server_URL: https://satellite.example.com

      Copy to Clipboard Toggle word wrap

   3. If you use an HTTP proxy to reach the Satellite API, store it in the vault too:

      My_HTTP_Proxy: "http://proxy.example.com:8080"

      Copy to Clipboard Toggle word wrap
   4. Save your changes and close the editor. Ansible encrypts the data in the vault.

2. Create a playbook file that references the vault file:

   Note

   The following YAML snippets include the module_defaults keyword to pass vault variables as parameters to all modules from the redhat.satellite.satellite group that are used in the playbook. Module defaults groups simplify parameter management by enabling you to define common parameters to groups of modules rather than having to pass the parameters to each module individually.

   1. Provide details on how to authenticate to the Satellite API.

      If you are authenticating with Satellite username and password or PAT, map the username, password, and server_url parameters to the contents of My_Vault.yml:

      - name: My Playbook
        hosts: localhost
        vars_files:
          - My_Vault.yml
        module_defaults:
          group/redhat.satellite.satellite:
            username: "{{ My_Username }}"
            password: "{{ My_Password }}"
            server_url: "{{ My_Server_URL }}"
        tasks:

      Copy to Clipboard Toggle word wrap

      If you are authenticating with a Kerberos ticket, map the server_url parameter to the contents of My_Vault.yml and add use_gssapi: true to enable Kerberos authentication:

      - name: My Playbook
        hosts: localhost
        vars_files:
          - My_Vault.yml
        module_defaults:
          group/redhat.satellite.satellite:
            server_url: "{{ My_Server_URL }}"
            use_gssapi: true
        tasks:

      Copy to Clipboard Toggle word wrap

   2. If you need to use an HTTP proxy to reach the Satellite API, set the https_proxy environment variable:

      - name: My Playbook
        hosts: localhost
        vars_files:
          - My_Vault.yml
        environment:
          https_proxy: "{{ My_HTTP_Proxy }}"
        module_defaults:
          group/redhat.satellite.satellite:
            username: "{{ My_Username }}"
            password: "{{ My_Password }}"
            server_url: "{{ My_Server_URL }}"
        tasks:

      Copy to Clipboard Toggle word wrap
   3. In the tasks: section, define the tasks that you want your playbook to perform.

3. Validate the playbook syntax:

   $ ansible-playbook --syntax-check --ask-vault-pass My_Playbook.yml

   Copy to Clipboard Toggle word wrap

   Note that this command only validates the syntax. It does not protect against a valid but incorrect configuration.

4. Run the playbook:

   $ ansible-playbook --ask-vault-pass My_Playbook.yml

   Copy to Clipboard Toggle word wrap