Chapter 13. Synchronizing Template Repositories

Procedure

1. In the Satellite web UI, navigate to Hosts > Sync Templates.
2. Click Import.
3. Each field is populated with values configured in Administer > Settings > TemplateSync. Change the values as required for the templates you want to import. For more information about each field, see Section 13.2, “Configuring the TemplateSync plug-in”.
4. Click Submit.

Procedure

1. In the Satellite web UI, navigate to Hosts > Sync Templates.
2. Click Export.
3. Each field is populated with values configured in Administer > Settings > TemplateSync. Change the values as required for the templates you want to export. For more information about each field, see Section 13.2, “Configuring the TemplateSync plug-in”.
4. Click Submit.

For CLI Users

1. Clone a local copy of your Git repository:

   $ git clone https://github.com/theforeman/community-templates /custom/templates

2. Change the owner of your local directory to the foreman user, and change the SELinux context with the following commands:

   # chown -R foreman:foreman /custom/templates
   # chcon -R -t httpd_sys_rw_content_t /custom/templates

3. To export the templates to your local repository, enter the following command:

   hammer export-templates --organization 'Default Organization' --repo /custom/templates

Procedure

1. Configure a version control system that uses SSH authorization, for example gitosis, gitolite, or git daemon.

2. Configure the TemplateSync plug-in settings on a TemplateSync tab.

   1. Change the Branch setting to match the target branch on a Git server.
   2. 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 ssh://git@git.example.com/templates.git.

3. Accept Git SSH host key as the foreman user:

   # sudo -u foreman ssh git.example.com

   You can see the Permission denied, please try again. message in the output, which is expected, because the SSH connection cannot succeed yet.

4. Create an SSH key pair if you do not already have it. Do not specify a passphrase.

   # sudo -u foreman ssh-keygen

5. Configure your version control server with the public key from your Satellite, which resides in /usr/share/foreman/.ssh/id_rsa.pub.

6. Export templates from your Satellite Server to the version control repository specified in the TemplateSync menu:

   $ curl -H "Accept:application/json,version=2" \
   -H "Content-Type:application/json" \
   -u login:password \
   -k https://_satellite.example.com/api/v2/templates/export \
   -X POST
   
   {"message":"Success"}

7. Import templates to Satellite Server after their content was changed:

   $ curl -H "Accept:application/json,version=2" \
   -H "Content-Type:application/json" \
   -u login:password \
   -k https://_satellite.example.com/api/v2/templates/import \
   -X POST
   
   {“message”:”Success”}

   Note that templates provided by Satellite are locked and you cannot import them by default. To overwrite this behavior, change the Force import setting in the TemplateSync menu to yes or add the force parameter -d '{ "force": "true" }’ to the import command.

Procedure

1. Create the directory where templates are stored and apply appropriate permissions and SELinux context:

   # mkdir -p /usr/share/templates_dir/
   # chown foreman /usr/share/templates_dir/
   # chcon -t httpd_sys_rw_content_t /usr/share/templates_dir/ -R

2. Change the Repo setting on the TemplateSync tab to match the export directory /usr/share/templates_dir/.

3. Export templates from your Satellite Server to a local directory:

   $ curl -H "Accept:application/json,version=2" \
   -H "Content-Type:application/json" \
   -u login:password \
   -k https://_satellite.example.com/api/v2/templates/export \
   -X POST \
   
   {"message":"Success"}

4. Import templates to Satellite Server after their content was changed:

   $ curl -H "Accept:application/json,version=2" \
   -H "Content-Type:application/json" \
   -u login:password \
   -k https://_satellite.example.com/api/v2/templates/import \
   -X POST
   
   {“message”:”Success”}

   Note that templates provided by Satellite are locked and you cannot import them by default. To overwrite this behavior, change the Force import setting in the TemplateSync menu to yes or add the force parameter -d '{ "force": "true" }’ to the import command.