allow branch specific alues for all bootstrap models

Author: nopg

changes/1030.added

@@ -0,0 +1 @@
+Added ability to manage branch specific values for models in Bootstrap integration.

docs/user/integrations/bootstrap.md

@@ -160,10 +160,32 @@ external_integration:
         - "9876"
 ```
 
+### Branch Specific Values
+If you are running multiple Nautobot environments, some values may need to be specific to the Nautobot environment. For example in `development` you might want all GitRepository objects to use the branch `develop`. Also for ScheduledJobs you might need to send specific UUID values as `job_vars`, which are unique to each Nautobot environment. You can create these 'branch values' that are specific to each object type. You will want to update your `PLUGINS_CONFIG` in `nautobot_config.py` to include the value you wish to use for the Branch Values File.
+
+```python
+PLUGINS_CONFIG = {
+    "nautobot_ssot": {
+        "bootstrap_nautobot_environment_branch": os.getenv("NAUTOBOT_BOOTSTRAP_SSOT_ENVIRONMENT_BRANCH", "develop"),
+    }
+}
+```
+
+Then create a YAML file in the same format as `global_settings.py`, to 'override' any specific object found in the Global Settings. If you wish to use a specific value for ALL object types, simply add an object with the `name` set to `default`, and it will take effect for all objects of that type that have a blank or missing value for that setting. If the object is already assigned a value, that value will take precedence over this default setting.
+
 #### develop.yml
 
 ```yaml
-git_branch: develop
+---
+git_repository: # Sets all git_repositories to this branch (if unspecified in global_settings)
+  - name: "default"
+    branch: "develop"
+# git_branch: "develop" # this method has been deprecated, use above method
+scheduled_job:
+  - name: "Test Scheduled Job" # Add job_vars with unique UUID's to a specific Job
+    job_vars:
+      integration: 1234567890
+      tenant: 987765412
 ```
 
 ## Content Types

nautobot_ssot/integrations/bootstrap/diffsync/adapters/bootstrap.py

@@ -1,2 +1,10 @@
 ---
-git_branch: "develop"
+git_repository:
+  - name: "default"
+    branch: "develop"
+# git_branch: "develop" # this method has been deprecated, use above method
+scheduled_job:
+  - name: "Test Scheduled Job"
+    job_vars:
+      integration: 1234567890
+      tenant: 987765412

nautobot_ssot/integrations/bootstrap/fixtures/develop.yml

@@ -597,7 +597,7 @@ software_image:
     image_file_checksum: ""
     hashing_algorithm: "SHA256"
     default_image: false
-    device_types: ["arista-switch"]
+    device_types: []
     tags: ["Test"]
   - software: "paloalto_panos - 11.0.3"
     status: "Active"
@@ -836,7 +836,7 @@ prefix:
 scheduled_job:
   - name: "Test Scheduled Job"
     interval: "daily"
-    start_time: "2025-01-28T23:00:00+00:00"
+    start_time: "2025-12-28 23:00:00+00:00"
     job_model: "Export Object List"
     user: "admin"
 custom_field:

nautobot_ssot/integrations/bootstrap/fixtures/global_settings.yml

@@ -870,8 +870,11 @@
       "user": "admin",
       "interval": "daily",
       "crontab": "",
-      "start_time": "2025-01-28T23:00:00+00:00",
-      "job_vars": {}
+      "start_time": "2025-12-28T23:00:00+00:00",
+      "job_vars": {
+        "integration": 1234567890,
+        "tenant": 987765412
+      }
     }
   ],
   "software_version": [

nautobot_ssot/tests/bootstrap/fixtures/global_settings.json

@@ -931,8 +931,10 @@ def _setup_git_repositories(self):
         for _repo in GLOBAL_YAML_SETTINGS["git_repository"]:
             if _repo.get("branch"):
                 _git_branch = _repo["branch"]
-            else:
+            elif DEVELOP_YAML_SETTINGS.get("git_branch"):
                 _git_branch = DEVELOP_YAML_SETTINGS["git_branch"]
+            else:
+                _git_branch = DEVELOP_YAML_SETTINGS["git_repository"][0]["branch"]
             _secrets_group = None
             if _repo.get("secrets_group_name"):
                 _secrets_group = SecretsGroup.objects.get(name=_repo["secrets_group_name"])
@@ -1051,14 +1053,18 @@ def _setup_scheduled_job(self):
         for scheduled_job in GLOBAL_YAML_SETTINGS["scheduled_job"]:
             # Parse the start_time to preserve timezone info
             start_time = get_scheduled_start_time(scheduled_job["start_time"])
+            if DEVELOP_YAML_SETTINGS.get("scheduled_job"):
+                job_vars = DEVELOP_YAML_SETTINGS["scheduled_job"][0]["job_vars"]
+            else:
+                job_vars = {}
             scheduled_job = ScheduledJob(
                 name=scheduled_job["name"],
                 task=job.class_path,
                 interval=scheduled_job["interval"],
                 start_time=start_time,
                 job_model=job,
                 user=admin,
-                kwargs={},
+                kwargs=job_vars,
             )
             scheduled_job.validated_save()