Merge branch 'master' into SAT-44059-pulp-import-export-support

Author: aidenfine

.github/workflows/test.yml

@@ -110,7 +110,7 @@ jobs:
           ./foremanctl pull-images
       - name: Run deployment
         run: |
-          ./foremanctl deploy --certificate-source=${{ matrix.certificate_source }} ${{ matrix.database == 'external' && '--database-mode=external --database-host=database.example.com --database-ssl-ca $(pwd)/.var/lib/foremanctl/db-ca.crt --database-ssl-mode verify-full' || '' }} --foreman-initial-admin-password=changeme --tuning development
+          ./foremanctl deploy --certificate-source=${{ matrix.certificate_source }} ${{ matrix.database == 'external' && '--database-mode=external --database-host=database.example.com --database-ssl-ca $(pwd)/.var/lib/foremanctl/db-ca.crt --database-ssl-mode verify-full' || '' }} --foreman-initial-admin-password=changeme --initial-organization "Foreman CI" --initial-location "Internet" --tuning development
       - name: Add optional feature - hammer
         run: |
           ./foremanctl deploy --add-feature hammer
@@ -174,7 +174,7 @@ jobs:
           ./forge setup-repositories
       - name: Run deployment
         run: |
-          ./forge deploy-dev --foreman-development-enabled-plugin foreman_ansible
+          ./forge deploy-dev --foreman-development-enabled-plugin foreman_ansible --add-feature foreman-proxy --add-feature hammer
       - name: Setup upterm session
         if: ${{ failure() }}
         uses: owenthereal/action-upterm@v1
@@ -219,7 +219,7 @@ jobs:
           ./foremanctl pull-images
       - name: Run deployment
         run: |
-          ./foremanctl deploy --foreman-initial-admin-password=changeme --tuning development
+          ./foremanctl deploy --foreman-initial-admin-password=changeme --initial-organization "Foreman CI" --initial-location "Internet" --tuning development
       - name: Add optional feature - hammer
         run: |
           ./foremanctl deploy --add-feature hammer

DEVELOPMENT.md

@@ -36,7 +36,7 @@ This setup uses Vagrant to create a basic VM for running the deployment on:
 ./setup-environment
 source .venv/bin/activate
 ./forge vms start
-./foremanctl deploy --foreman-initial-admin-password=changeme --tuning development
+./foremanctl deploy --foreman-initial-admin-password=changeme --tuning development --initial-organization "Foreman CI" --initial-location "Internet"
 ```
 
 ### Deploy hammer (optional)

development/playbooks/deploy-dev/deploy-dev.yaml

@@ -39,6 +39,10 @@
     - role: httpd
     - role: pulp
     - role: foreman_development
+      vars:
+        foreman_development_oauth_consumer_key: "{{ foreman_oauth_consumer_key }}"
+        foreman_development_oauth_consumer_secret: "{{ foreman_oauth_consumer_secret }}"
+        foreman_development_candlepin_oauth_secret: "{{ candlepin_oauth_secret }}"
   post_tasks:
     - name: Display development environment information
       ansible.builtin.debug:

development/requirements.yml

@@ -9,4 +9,5 @@ collections:
   - name: https://github.com/theforeman/forklift
     type: git
   - name: theforeman.foreman
+    version: ">=5.11.0"
   - name: theforeman.operations

development/roles/foreman_development/defaults/main.yaml

@@ -14,6 +14,8 @@ foreman_development_client_key: "{{ foreman_client_key }}"
 foreman_development_admin_user: "admin"
 foreman_development_admin_password: "changeme"
 
+foreman_development_candlepin_url: "https://localhost:23443/candlepin"
+
 foreman_development_git_repo: "https://github.com/theforeman/foreman.git"
 foreman_development_git_revision: "develop"
 foreman_development_github_username: ""

development/roles/foreman_development/tasks/main.yaml

@@ -221,7 +221,7 @@
 - name: Wait for Foreman development server to be accessible
   ansible.builtin.uri:
     url: '{{ foreman_development_url }}/api/v2/ping'
-    validate_certs: false
+    ca_path: '{{ foreman_development_ca_certificate }}'
   until: foreman_development_status.status == 200
   retries: 30
   delay: 5
@@ -234,7 +234,7 @@
     server_url: "{{ foreman_development_url }}"
     username: "{{ foreman_development_admin_user }}"
     password: "{{ foreman_development_admin_password }}"
-    validate_certs: false
+    ca_path: "{{ foreman_development_ca_certificate }}"
 
 - name: Stop Foreman development service after smart proxy registration
   ansible.builtin.systemd:

development/roles/foreman_development/tasks/smart-proxy/main.yml

@@ -114,8 +114,8 @@
 
 - name: Wait for smart-proxy development server to be accessible
   ansible.builtin.uri:
-    url: "http://{{ ansible_facts['fqdn'] }}:8000/features"
-    validate_certs: false
+    url: "https://{{ ansible_facts['fqdn'] }}:8443/features"
+    ca_path: "{{ foreman_development_ca_certificate }}"
   until: foreman_development_smart_proxy_status.status == 200
   retries: 30
   delay: 5
@@ -130,7 +130,7 @@
 - name: Wait for Foreman development server to be accessible
   ansible.builtin.uri:
     url: '{{ foreman_development_url }}/api/v2/ping'
-    validate_certs: false
+    ca_path: '{{ foreman_development_ca_certificate }}'
   until: foreman_development_status.status == 200
   retries: 30
   delay: 5
@@ -141,9 +141,9 @@
     name: "{{ ansible_facts['fqdn'] }}-dev"
     url: "https://{{ ansible_facts['fqdn'] }}:8443"
     server_url: "{{ foreman_development_url }}"
-    username: "{{ foreman_development_admin_user }}"
-    password: "{{ foreman_development_admin_password }}"
-    validate_certs: false
+    oauth1_consumer_key: "{{ foreman_development_oauth_consumer_key }}"
+    oauth1_consumer_secret: "{{ foreman_development_oauth_consumer_secret }}"
+    ca_path: "{{ foreman_development_ca_certificate }}"
 
 - name: Stop development services after smart proxy registration
   ansible.builtin.systemd:

development/roles/foreman_development/templates/katello.yaml.j2

@@ -6,9 +6,9 @@
   :katello_applicability: true
 
   :candlepin:
-    :url: {{ candlepin_url | default('https://localhost:23443/candlepin') }}
+    :url: {{ foreman_development_candlepin_url }}
     :oauth_key: katello
-    :oauth_secret: {{ candlepin_oauth_secret }}
+    :oauth_secret: {{ foreman_development_candlepin_oauth_secret }}
     :ca_cert_file: {{ foreman_development_cert_dir }}/proxy_ca.pem
 
   :candlepin_events:

development/roles/foreman_development/templates/settings.yaml.j2

@@ -9,9 +9,9 @@
 
 # The following values are used for providing default settings during db migrate
 :oauth_active: true
-:oauth_map_users: true
-:oauth_consumer_key: {{ candlepin_oauth_key | default('katello') }}
-:oauth_consumer_secret: {{ candlepin_oauth_secret }}
+:oauth_map_users: false
+:oauth_consumer_key: {{ foreman_development_oauth_consumer_key }}
+:oauth_consumer_secret: {{ foreman_development_oauth_consumer_secret }}
 
 # SSL settings
 :ssl_ca_file: {{ foreman_development_cert_dir }}/proxy_ca.pem

docs/migration-guide.md

@@ -0,0 +1,138 @@
+# Migrating from foreman-installer to foremanctl
+
+## Overview
+
+When upgrading from foreman-installer to foremanctl, the `foremanctl migrate` command helps convert your existing configuration to the new format.
+
+This guide explains how to migrate your foreman-installer answer files to foremanctl configuration files.
+
+## Prerequisites
+
+Before migrating, ensure the following:
+
+1. **Foreman deployment using foreman-installer** - You should have an existing Foreman deployment has been installed using foreman-installer and has an answers file to migrate from.
+
+2. **foremanctl is installed** on the system:
+   ```bash
+   # Enable the foremanctl repository
+   dnf copr enable @theforeman/foremanctl rhel-9-x86_64
+
+   # Install foremanctl
+   dnf install foremanctl
+   ```
+
+   For more installation options, see the main [README](../README.md#packages).
+
+## Migration Workflow
+
+1. **Generate the migrated configuration**:
+   ```bash
+   foremanctl migrate --output /var/lib/foremanctl/parameters.yaml
+   ```
+
+2. **Review the output** for any warnings about unmapped parameters
+
+3. **Use the migrated configuration** with foremanctl:
+   ```bash
+   foremanctl deploy
+   ```
+   (foremanctl automatically loads configuration from `/var/lib/foremanctl/parameters.yaml`)
+
+## Command Usage
+
+### Basic Migration
+
+Migrate from the default location (reads the currently active scenario):
+```bash
+foremanctl migrate --output /var/lib/foremanctl/parameters.yaml
+```
+
+### Custom Answer File
+
+Migrate from a specific answer file:
+```bash
+foremanctl migrate --answer-file /path/to/custom-answers.yaml --output /var/lib/foremanctl/parameters.yaml
+```
+
+### Output to stdout
+
+Preview the migrated configuration without writing a file:
+```bash
+foremanctl migrate
+```
+
+## Command Options
+
+- `--answer-file PATH` - Path to the foreman-installer answer file. If not specified, reads the currently active scenario and extracts the answer file path from it.
+- `--output PATH` - Path for the migrated configuration (default: stdout)
+
+> [!NOTE]
+> Unlike other `foremanctl` commands, migrate does not persist parameters between runs. Each migration is independent.
+
+## Parameter Mappings
+
+The migrate command automatically maps foreman-installer parameters to foremanctl parameters. For a complete list of all parameter mappings, see the [Parameters documentation](parameters.md#mapping).
+
+## Example
+
+Below is an example showing how the transformation works:
+
+### Input (foreman-installer format)
+
+```yaml
+foreman:
+  db_host: database.example.com
+  db_port: 5432
+  db_database: foreman
+  db_username: foreman_user
+  db_password: secret123
+  db_manage: true
+  initial_admin_username: admin
+  initial_admin_password: changeme
+```
+
+### Output (foremanctl format)
+
+```yaml
+database_host: database.example.com
+database_port: 5432
+database_mode: external
+foreman_database_name: foreman
+foreman_database_password: secret123
+foreman_database_user: foreman_user
+foreman_initial_admin_password: changeme
+foreman_initial_admin_username: admin
+```
+
+## Handling Unmapped Parameters
+
+When the migration completes, you may see warnings like:
+
+> [!WARNING]  
+> The following parameters could not be mapped:
+>  - katello::enable_ostree
+> - foreman::some_other_param
+
+These parameters need to be manually reviewed and added to the new configuration if needed. Check the [parameters documentation](parameters.md) for equivalent foremanctl parameters.
+
+## Using the Migrated Configuration
+
+Once you've generated and reviewed the migrated configuration:
+
+1. **Save it to the foremanctl parameters file**:
+   ```bash
+   # Either generate directly to the parameters file
+   foremanctl migrate --output /var/lib/foremanctl/parameters.yaml
+
+   # Or copy after review
+   foremanctl migrate --output /tmp/migrated.yaml
+   # Review /tmp/migrated.yaml
+   cp /tmp/migrated.yaml /var/lib/foremanctl/parameters.yaml
+   ```
+
+2. **Deploy using foremanctl**:
+   ```bash
+   foremanctl deploy
+   ```
+
+   The `foremanctl deploy` command automatically loads configuration from `/var/lib/foremanctl/parameters.yaml`.