Chapter 14. Synchronizing Template Repositories

Procedure

1. If you want to use HTTPS to connect to the repository and you use a self-signed certificate authority (CA) on your Git server:

   1. Create a new directory under the /usr/share/foreman/ directory to store the Git configuration for the certificate:

      # mkdir --parents /usr/share/foreman/.config/git

   2. Create a file named config in the new directory:

      # touch /usr/share/foreman/.config/git/config

   3. Allow the foreman user access to the .config directory:

      # chown --recursive foreman /usr/share/foreman/.config

   4. Update the Git global configuration for the foreman user with the path to your self-signed CA certificate:

      # sudo --user foreman git config --global http.sslCAPath Path_To_CA_Certificate

2. If you want to use SSH to connect to the repository:

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

      # sudo --user foreman ssh-keygen

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

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

      # sudo --user foreman ssh git.example.com

3. 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 git@git.example.com/templates.git.

Procedure

1. In /var/lib/foreman, create a directory for storing templates:

   # mkdir /var/lib/foreman/My_Templates_Dir

   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.

2. Change the owner of the new templates directory to the foreman user:

   # chown foreman /var/lib/foreman/My_Templates_Dir

3. Change the Repo setting on the TemplateSync tab to match the /var/lib/foreman/My_Templates_Dir/ directory.

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 14.2, “Configuring the TemplateSync Plug-in”.
4. Click Submit.

API Procedure

1. Send a POST request to api/v2/templates/import:

   # curl -H "Accept:application/json" \
   -H "Content-Type:application/json" \
   -u login:password \
   -k https://satellite.example.com/api/v2/templates/import \
   -X POST

   If the import is successful, you receive {"message":"Success"}.

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 14.2, “Configuring the TemplateSync Plug-in”.
4. Click Submit.

CLI procedure

1. To export the templates to a repository, enter the following command:

   # hammer export-templates \
   --organization "My_Organization" \
   --repo "https://git.example.com/path/to/repository"

   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

1. Send a POST request to api/v2/templates/export:

   # curl -H "Accept:application/json" \
   -H "Content-Type:application/json" \
   -u login:password \
   -k https://satellite.example.com/api/v2/templates/export \
   -X POST

   If the export is successful, you receive {"message":"Success"}.