Chapter 14. Synchronizing template repositories
Chapter 14. Synchronizing template repositories In Satellite, you can synchronize repositories of job templates, provisioning templates, report templates, and partition table templates between Satellite Server and a version control system or local directory. In this chapter, a Git repository is used for demonstration purposes. This section details the workflow for installing and configuring the Template Sync plugin and performing exporting and importing tasks. 14.1. Enabling the Template Sync plugin Procedure To enable the plugin on your Satellite Server, enter the following command: To verify that the plugin is installed correctly, ensure Administer > Settings includes the Template Sync menu. Optional: In the Satellite web UI, navigate to Administer > Settings > Template Sync to configure the plugin. For more information, see Template sync settings in Administering Red Hat Satellite . 14.2. Using repository sources You can use existing repositories or local directories to synchronize templates with your Satellite Server. 14.2.1. Synchronizing templates with an existing repository Use this procedure to synchronize templates between your Satellite Server and an existing repository. Procedure If you want to use HTTPS to connect to the repository and you use a self-signed certificate authority (CA) on your Git server: Create a new directory under the /usr/share/foreman/ directory to store the Git configuration for the certificate: Create a file named config in the new directory: Allow the foreman user access to the .config directory: Update the Git global configuration for the foreman user with the path to your self-signed CA certificate: If you want to use SSH to connect to the repository: Create an SSH key pair if you do not already have it. Do not specify a passphrase. Configure your version control server with the public key from your Satellite, which resides in /usr/share/foreman/.ssh/id_rsa.pub . Accept the Git SSH host key as the foreman user: Configure the Template Sync plugin settings on a Template Sync tab. Change the Branch setting to match the target branch on a Git server. Change the Repo setting to match the Git repository. For example, for the repository located in git@git.example.com/templates.git set the setting into git@git.example.com/templates.git . 14.2.2. Synchronizing templates with a local directory Synchronizing templates with a local directory is useful if you have configured a version control repository in the local directory. That way, you can edit templates and track the history of edits in the directory. You can also synchronize changes to Satellite Server after editing the templates. Prerequisites Each template must contain the location and organization that the template belongs to. This applies to all template types. Before you import a template, ensure that you add the following section to the template: Procedure In /var/lib/foreman , create a directory for storing templates: Note You can place your templates to a custom directory outside /var/lib/foreman , but you have to ensure that the Foreman service can read its contents. The directory must have the correct file permissions and the foreman_lib_t SELinux label. Change the owner of the new templates directory to the foreman user: Change the Repo setting on the Template Sync tab to match the /var/lib/foreman/ My_Templates_Dir / directory. 14.3. Importing and exporting templates You can import and export templates using the Satellite web UI, Hammer CLI, or Satellite API. Satellite API calls use the role-based access control system, which enables the tasks to be executed as any user. You can synchronize templates with a version control system, such as Git, or a local directory. 14.3.1. Importing templates You can import templates from a repository of your choice. You can use different protocols to point to your repository, for example /tmp/dir , git://example.com , https://example.com , and ssh://example.com . Note The templates provided by Satellite are locked and you cannot import them by default. To overwrite this behavior, change the Force import setting in the Template Sync menu to yes or add the force parameter -d '{ "force": "true" }' to the import command. Prerequisites Each template must contain the location and organization that the template belongs to. This applies to all template types. Before you import a template, ensure that you add the following section to the template: To use the CLI instead of the Satellite web UI, see the ]. To use the API, see the xref:api_Importing_Templates_managing-hosts[ . Procedure In the Satellite web UI, navigate to Hosts > Templates > Sync Templates . Click Import . Each field is populated with values configured in Administer > Settings > Template Sync . Change the values as required for the templates you want to import. For more information about each field, see Template sync settings in Administering Red Hat Satellite . Click Submit . The Satellite web UI displays the status of the import. The status is not persistent; if you leave the status page, you cannot return to it. CLI procedure To import a template from a repository, enter the following command: For better indexing and management of your templates, use --prefix to set a category for your templates. To select certain templates from a large repository, use --filter to define the title of the templates that you want to import. For example --filter '.*Ansible DefaultUSD' imports various Ansible Default templates. API procedure Send a POST request to api/v2/templates/import : If the import is successful, you receive {"message":"Success"} . 14.3.2. Exporting templates Use this procedure to export templates to a git repository. To use the CLI instead of the Satellite web UI, see the ]. To use the API, see the xref:api_Exporting_Templates_managing-hosts[ . Procedure In the Satellite web UI, navigate to Hosts > Templates > Sync Templates . Click Export . Each field is populated with values configured in Administer > Settings > Template Sync . Change the values as required for the templates you want to export. For more information about each field, see Template sync settings in Administering Red Hat Satellite . Click Submit . The Satellite web UI displays the status of the export. The status is not persistent; if you leave the status page, you cannot return to it. CLI procedure To export the templates to a repository, enter the following command: Note This command clones the repository, makes changes in a commit, and pushes back to the repository. You can use the --branch " My_Branch " option to export the templates to a specific branch. API procedure Send a POST request to api/v2/templates/export : If the export is successful, you receive {"message":"Success"} . Note You can override default API settings by specifying them in the request with the -d parameter. The following example exports templates to the git.example.com/templates repository:
satellite-installer --enable-foreman-plugin-templates mkdir --parents /usr/share/foreman/.config/git touch /usr/share/foreman/.config/git/config chown --recursive foreman /usr/share/foreman/.config sudo --user foreman git config --global http.sslCAPath Path_To_CA_Certificate sudo --user foreman ssh-keygen sudo --user foreman ssh git.example.com <%# kind: provision name: My_Provisioning_Template oses: - My_first_OS - My_second_OS locations: - My_first_Location - My_second_Location organizations: - My_first_Organization - My_second_Organization %> mkdir /var/lib/foreman/ My_Templates_Dir chown foreman /var/lib/foreman/ My_Templates_Dir <%# kind: provision name: My_Provisioning_Template oses: - My_first_OS - My_second_OS locations: - My_first_Location - My_second_Location organizations: - My_first_Organization - My_second_Organization %> hammer import-templates --branch " My_Branch " --filter '.* Template NameUSD ' --organization " My_Organization " --prefix "[ Custom Index ] " --repo " https://git.example.com/path/to/repository " curl -H "Accept:application/json" -H "Content-Type:application/json" -u login : password -k https:// satellite.example.com /api/v2/templates/import -X POST hammer export-templates --organization " My_Organization " --repo " https://git.example.com/path/to/repository " curl -H "Accept:application/json" -H "Content-Type:application/json" -u login : password -k https:// satellite.example.com /api/v2/templates/export -X POST curl -H "Accept:application/json" -H "Content-Type:application/json" -u login:password -k https:// satellite.example.com /api/v2/templates/export -X POST -d "{\"repo\":\"git.example.com/templates\"}"