nautobot 2.3.3__py3-none-any.whl → 2.3.4__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of nautobot might be problematic. Click here for more details.
- nautobot/core/celery/schedulers.py +2 -2
- nautobot/core/settings.py +3 -1
- nautobot/core/settings.yaml +40 -23
- nautobot/core/tests/test_settings_schema.py +7 -3
- nautobot/dcim/tables/power.py +1 -1
- nautobot/dcim/tests/test_filters.py +1 -1
- nautobot/project-static/docs/404.html +58 -146
- nautobot/project-static/docs/additional-features/caching.html +3 -3
- nautobot/project-static/docs/additional-features/healthcheck.html +3 -3
- nautobot/project-static/docs/apps/index.html +58 -146
- nautobot/project-static/docs/apps/nautobot-apps.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/__init__.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/admin.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/api.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/change_logging.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/choices.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/config.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/constants.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/datasources.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/exceptions.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/factory.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/filters.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/forms.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/graphql.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/jobs.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/models.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/querysets.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/secrets.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/tables.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/testing.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/ui.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/urls.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/utils.html +58 -146
- nautobot/project-static/docs/code-reference/nautobot/apps/views.html +58 -146
- nautobot/project-static/docs/configuration/optional-settings.html +3 -3
- nautobot/project-static/docs/configuration/required-settings.html +3 -3
- nautobot/project-static/docs/development/apps/api/configuration-view.html +58 -146
- nautobot/project-static/docs/development/apps/api/database-backend-config.html +58 -146
- nautobot/project-static/docs/development/apps/api/models/django-admin.html +58 -146
- nautobot/project-static/docs/development/apps/api/models/global-search.html +58 -146
- nautobot/project-static/docs/development/apps/api/models/graphql.html +58 -146
- nautobot/project-static/docs/development/apps/api/models/index.html +58 -146
- nautobot/project-static/docs/development/apps/api/nautobot-app-config.html +58 -146
- nautobot/project-static/docs/development/apps/api/platform-features/custom-validators.html +58 -146
- nautobot/project-static/docs/development/apps/api/platform-features/filter-extensions.html +58 -146
- nautobot/project-static/docs/development/apps/api/platform-features/git-repository-content.html +58 -146
- nautobot/project-static/docs/development/apps/api/platform-features/index.html +58 -146
- nautobot/project-static/docs/development/apps/api/platform-features/jinja2-filters.html +58 -146
- nautobot/project-static/docs/development/apps/api/platform-features/jobs.html +58 -146
- nautobot/project-static/docs/development/apps/api/platform-features/populating-extensibility-features.html +58 -146
- nautobot/project-static/docs/development/apps/api/platform-features/secrets-providers.html +58 -146
- nautobot/project-static/docs/development/apps/api/platform-features/uniquely-identify-objects.html +60 -148
- nautobot/project-static/docs/development/apps/api/prometheus.html +58 -146
- nautobot/project-static/docs/development/apps/api/setup.html +58 -146
- nautobot/project-static/docs/development/apps/api/testing.html +59 -147
- nautobot/project-static/docs/development/apps/api/ui-extensions/banners.html +58 -146
- nautobot/project-static/docs/development/apps/api/ui-extensions/home-page.html +58 -146
- nautobot/project-static/docs/development/apps/api/ui-extensions/index.html +58 -146
- nautobot/project-static/docs/development/apps/api/ui-extensions/navigation.html +58 -146
- nautobot/project-static/docs/development/apps/api/ui-extensions/object-views.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/base-template.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/core-view-overrides.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/django-generic-views.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/help-documentation.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/index.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/nautobot-generic-views.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/nautobotuiviewset.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/nautobotuiviewsetrouter.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/notes.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/rest-api.html +58 -146
- nautobot/project-static/docs/development/apps/api/views/urls.html +58 -146
- nautobot/project-static/docs/development/apps/index.html +59 -147
- nautobot/project-static/docs/development/apps/migration/code-updates.html +58 -146
- nautobot/project-static/docs/development/apps/migration/dependency-updates.html +58 -146
- nautobot/project-static/docs/development/apps/migration/from-v1.html +58 -146
- nautobot/project-static/docs/development/apps/migration/model-updates/dcim.html +58 -146
- nautobot/project-static/docs/development/apps/migration/model-updates/extras.html +58 -146
- nautobot/project-static/docs/development/apps/migration/model-updates/global.html +58 -146
- nautobot/project-static/docs/development/apps/migration/model-updates/ipam.html +58 -146
- nautobot/project-static/docs/development/apps/porting-from-netbox.html +58 -146
- nautobot/project-static/docs/development/core/application-registry.html +58 -146
- nautobot/project-static/docs/development/core/best-practices.html +58 -146
- nautobot/project-static/docs/development/core/bootstrap-ui.html +58 -146
- nautobot/project-static/docs/development/core/caching.html +58 -146
- nautobot/project-static/docs/development/core/controllers.html +58 -146
- nautobot/project-static/docs/development/core/docker-compose-advanced-use-cases.html +58 -146
- nautobot/project-static/docs/development/core/generic-views.html +58 -146
- nautobot/project-static/docs/development/core/getting-started.html +81 -166
- nautobot/project-static/docs/development/core/homepage.html +58 -146
- nautobot/project-static/docs/development/core/index.html +58 -146
- nautobot/project-static/docs/development/core/model-checklist.html +58 -146
- nautobot/project-static/docs/development/core/model-features.html +58 -146
- nautobot/project-static/docs/development/core/natural-keys.html +58 -146
- nautobot/project-static/docs/development/core/navigation-menu.html +58 -146
- nautobot/project-static/docs/development/core/release-checklist.html +58 -146
- nautobot/project-static/docs/development/core/role-internals.html +58 -146
- nautobot/project-static/docs/development/core/settings.html +58 -146
- nautobot/project-static/docs/development/core/style-guide.html +58 -146
- nautobot/project-static/docs/development/core/templates.html +58 -146
- nautobot/project-static/docs/development/core/testing.html +60 -148
- nautobot/project-static/docs/development/core/user-preferences.html +58 -146
- nautobot/project-static/docs/development/index.html +58 -146
- nautobot/project-static/docs/development/jobs/index.html +66 -154
- nautobot/project-static/docs/development/jobs/migration/from-v1.html +59 -147
- nautobot/project-static/docs/docker/index.html +3 -3
- nautobot/project-static/docs/index.html +58 -146
- nautobot/project-static/docs/installation/selinux-troubleshooting.html +3 -3
- nautobot/project-static/docs/overview/application_stack.html +58 -146
- nautobot/project-static/docs/overview/design_philosophy.html +58 -146
- nautobot/project-static/docs/release-notes/index.html +58 -146
- nautobot/project-static/docs/release-notes/version-1.0.html +58 -146
- nautobot/project-static/docs/release-notes/version-1.1.html +59 -147
- nautobot/project-static/docs/release-notes/version-1.2.html +61 -149
- nautobot/project-static/docs/release-notes/version-1.3.html +59 -147
- nautobot/project-static/docs/release-notes/version-1.4.html +60 -148
- nautobot/project-static/docs/release-notes/version-1.5.html +60 -148
- nautobot/project-static/docs/release-notes/version-1.6.html +62 -150
- nautobot/project-static/docs/release-notes/version-2.0.html +59 -147
- nautobot/project-static/docs/release-notes/version-2.1.html +60 -148
- nautobot/project-static/docs/release-notes/version-2.2.html +58 -146
- nautobot/project-static/docs/release-notes/version-2.3.html +267 -204
- nautobot/project-static/docs/search/search_index.json +1 -1
- nautobot/project-static/docs/sitemap.xml +277 -285
- nautobot/project-static/docs/sitemap.xml.gz +0 -0
- nautobot/project-static/docs/user-guide/administration/configuration/authentication/ldap.html +60 -148
- nautobot/project-static/docs/user-guide/administration/configuration/authentication/remote.html +59 -147
- nautobot/project-static/docs/user-guide/administration/configuration/authentication/sso.html +60 -148
- nautobot/project-static/docs/user-guide/administration/configuration/index.html +69 -167
- nautobot/project-static/docs/user-guide/administration/configuration/optional-settings.html +13 -12524
- nautobot/project-static/docs/user-guide/administration/configuration/redis.html +8966 -0
- nautobot/project-static/docs/user-guide/administration/configuration/required-settings.html +13 -9218
- nautobot/project-static/docs/user-guide/administration/configuration/settings.html +12734 -0
- nautobot/project-static/docs/user-guide/administration/configuration/time-zones.html +62 -150
- nautobot/project-static/docs/user-guide/administration/guides/caching.html +13 -9108
- nautobot/project-static/docs/user-guide/administration/guides/celery-queues.html +59 -147
- nautobot/project-static/docs/user-guide/administration/guides/docker.html +9491 -0
- nautobot/project-static/docs/user-guide/administration/guides/health-checks.html +9478 -0
- nautobot/project-static/docs/user-guide/administration/guides/healthcheck.html +13 -8833
- nautobot/project-static/docs/user-guide/administration/guides/permissions.html +62 -150
- nautobot/project-static/docs/user-guide/administration/guides/prometheus-metrics.html +59 -147
- nautobot/project-static/docs/user-guide/administration/guides/replicating-nautobot.html +59 -147
- nautobot/project-static/docs/user-guide/administration/guides/request-profiling.html +58 -146
- nautobot/project-static/docs/user-guide/administration/guides/s3-django-storage.html +58 -146
- nautobot/project-static/docs/user-guide/administration/guides/selinux-troubleshooting.html +8978 -0
- nautobot/project-static/docs/user-guide/administration/installation/app-install.html +58 -146
- nautobot/project-static/docs/user-guide/administration/installation/docker.html +3 -3
- nautobot/project-static/docs/user-guide/administration/installation/external-authentication.html +61 -149
- nautobot/project-static/docs/user-guide/administration/installation/health-checks.html +3 -3
- nautobot/project-static/docs/user-guide/administration/installation/http-server.html +59 -149
- nautobot/project-static/docs/user-guide/administration/installation/index.html +60 -148
- nautobot/project-static/docs/user-guide/administration/installation/install_system.html +58 -146
- nautobot/project-static/docs/user-guide/administration/installation/nautobot.html +74 -159
- nautobot/project-static/docs/user-guide/administration/installation/selinux-troubleshooting.html +3 -3
- nautobot/project-static/docs/user-guide/administration/installation/services.html +60 -148
- nautobot/project-static/docs/user-guide/administration/installation-extras/docker.html +13 -9577
- nautobot/project-static/docs/user-guide/administration/installation-extras/health-checks.html +13 -9560
- nautobot/project-static/docs/user-guide/administration/installation-extras/selinux-troubleshooting.html +13 -9064
- nautobot/project-static/docs/user-guide/administration/migration/migrating-from-netbox.html +60 -148
- nautobot/project-static/docs/user-guide/administration/migration/migrating-from-postgresql.html +58 -146
- nautobot/project-static/docs/user-guide/administration/tools/nautobot-server.html +64 -152
- nautobot/project-static/docs/user-guide/administration/tools/nautobot-shell.html +61 -149
- nautobot/project-static/docs/user-guide/administration/upgrading/database-backup.html +64 -152
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/after-you-upgrade.html +61 -149
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/before-you-upgrade.html +61 -149
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/for-developers.html +61 -149
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/index.html +61 -149
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/whats-changed.html +61 -149
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/region-and-site-data-migration-guide.html +61 -149
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1.html +63 -151
- nautobot/project-static/docs/user-guide/administration/upgrading/upgrading.html +61 -149
- nautobot/project-static/docs/user-guide/core-data-model/circuits/circuit.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittermination.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittype.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/circuits/provider.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/circuits/providernetwork.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloud.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudaccount.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetwork.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetworkprefixassignment.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudresourcetype.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservice.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservicenetworkassignment.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/cable.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleport.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleporttemplate.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverport.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverporttemplate.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/controller.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/controllermanageddevicegroup.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/device.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebay.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebaytemplate.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicefamily.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/deviceredundancygroup.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicetype.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/frontport.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/frontporttemplate.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/interface.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/interfaceredundancygroup.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/interfacetemplate.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/inventoryitem.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/location.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/locationtype.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/manufacturer.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/module.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebay.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebaytemplate.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/moduletype.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/platform.html +59 -147
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerfeed.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlet.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlettemplate.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerpanel.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerport.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerporttemplate.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rack.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rackgroup.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rackreservation.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rearport.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rearporttemplate.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareimagefile.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareversion.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/dcim/virtualchassis.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/extras/configcontext.html +59 -147
- nautobot/project-static/docs/user-guide/core-data-model/extras/configcontextschema.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/extras/contact.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/extras/team.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/ipam/ipaddress.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/ipam/namespace.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/ipam/prefix.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/ipam/rir.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/ipam/routetarget.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/ipam/service.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/ipam/vlan.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/ipam/vlangroup.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/ipam/vrf.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/overview/introduction.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenant.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenantgroup.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/cluster.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustergroup.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustertype.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/virtualmachine.html +58 -146
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/vminterface.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/contacts-and-teams.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/custom-fields.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-devices.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-location-types-and-locations.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/index.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/interfaces.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/ipam.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/platforms.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/search-bar.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/tenants.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/vlans-and-vlan-groups.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/git-data-source.html +59 -147
- nautobot/project-static/docs/user-guide/feature-guides/graphql.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/ip-address-merge-tool.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/relationships.html +58 -146
- nautobot/project-static/docs/user-guide/feature-guides/software-image-files-and-versions.html +58 -146
- nautobot/project-static/docs/user-guide/index.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/change-logging.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/computedfield.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/customfield.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/customlink.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/dynamicgroup.html +59 -147
- nautobot/project-static/docs/user-guide/platform-functionality/exporttemplate.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/externalintegration.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/gitrepository.html +59 -147
- nautobot/project-static/docs/user-guide/platform-functionality/graphql.html +60 -148
- nautobot/project-static/docs/user-guide/platform-functionality/graphqlquery.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/imageattachment.html +59 -147
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/index.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/job-scheduling-and-approvals.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobbutton.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobhook.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/models.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/napalm.html +59 -147
- nautobot/project-static/docs/user-guide/platform-functionality/note.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/objectmetadata.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/relationship.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/authentication.html +59 -147
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/filtering.html +59 -147
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/overview.html +60 -148
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/ui-related-endpoints.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/role.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/savedview.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/secret.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/staticgroupassociation.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/status.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/tag.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/template-filters.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/users/objectpermission.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/users/token.html +58 -146
- nautobot/project-static/docs/user-guide/platform-functionality/webhook.html +58 -146
- nautobot/virtualization/filters.py +6 -1
- nautobot/virtualization/tables.py +2 -2
- {nautobot-2.3.3.dist-info → nautobot-2.3.4.dist-info}/METADATA +1 -1
- {nautobot-2.3.3.dist-info → nautobot-2.3.4.dist-info}/RECORD +303 -299
- nautobot/project-static/docs/user-guide/administration/configuration/render-settings-fragment.j2 +0 -76
- {nautobot-2.3.3.dist-info → nautobot-2.3.4.dist-info}/LICENSE.txt +0 -0
- {nautobot-2.3.3.dist-info → nautobot-2.3.4.dist-info}/NOTICE +0 -0
- {nautobot-2.3.3.dist-info → nautobot-2.3.4.dist-info}/WHEEL +0 -0
- {nautobot-2.3.3.dist-info → nautobot-2.3.4.dist-info}/entry_points.txt +0 -0
|
@@ -783,7 +783,7 @@
|
|
|
783
783
|
|
|
784
784
|
|
|
785
785
|
<span class="md-ellipsis">
|
|
786
|
-
|
|
786
|
+
Upgrading
|
|
787
787
|
</span>
|
|
788
788
|
|
|
789
789
|
|
|
@@ -792,115 +792,6 @@
|
|
|
792
792
|
|
|
793
793
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_2_label" aria-expanded="false">
|
|
794
794
|
<label class="md-nav__title" for="__nav_2_1_2">
|
|
795
|
-
<span class="md-nav__icon md-icon"></span>
|
|
796
|
-
Installation Extras
|
|
797
|
-
</label>
|
|
798
|
-
<ul class="md-nav__list" data-md-scrollfix>
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
<li class="md-nav__item">
|
|
807
|
-
<a href="../../user-guide/administration/installation-extras/docker.html" class="md-nav__link">
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
<span class="md-ellipsis">
|
|
811
|
-
Nautobot Docker Images
|
|
812
|
-
</span>
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
</a>
|
|
816
|
-
</li>
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
<li class="md-nav__item">
|
|
828
|
-
<a href="../../user-guide/administration/installation-extras/health-checks.html" class="md-nav__link">
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
<span class="md-ellipsis">
|
|
832
|
-
Health Checks
|
|
833
|
-
</span>
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
</a>
|
|
837
|
-
</li>
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
<li class="md-nav__item">
|
|
849
|
-
<a href="../../user-guide/administration/installation-extras/selinux-troubleshooting.html" class="md-nav__link">
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
<span class="md-ellipsis">
|
|
853
|
-
SELinux Troubleshooting
|
|
854
|
-
</span>
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
</a>
|
|
858
|
-
</li>
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
</ul>
|
|
864
|
-
</nav>
|
|
865
|
-
|
|
866
|
-
</li>
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
<li class="md-nav__item md-nav__item--nested">
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3" >
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
<label class="md-nav__link" for="__nav_2_1_3" id="__nav_2_1_3_label" tabindex="0">
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
<span class="md-ellipsis">
|
|
895
|
-
Upgrading
|
|
896
|
-
</span>
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
<span class="md-nav__icon md-icon"></span>
|
|
900
|
-
</label>
|
|
901
|
-
|
|
902
|
-
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_3_label" aria-expanded="false">
|
|
903
|
-
<label class="md-nav__title" for="__nav_2_1_3">
|
|
904
795
|
<span class="md-nav__icon md-icon"></span>
|
|
905
796
|
Upgrading
|
|
906
797
|
</label>
|
|
@@ -965,7 +856,7 @@
|
|
|
965
856
|
|
|
966
857
|
|
|
967
858
|
|
|
968
|
-
<input class="md-nav__toggle md-toggle " type="checkbox" id="
|
|
859
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3" >
|
|
969
860
|
|
|
970
861
|
|
|
971
862
|
|
|
@@ -981,14 +872,14 @@
|
|
|
981
872
|
</a>
|
|
982
873
|
|
|
983
874
|
|
|
984
|
-
<label class="md-nav__link " for="
|
|
875
|
+
<label class="md-nav__link " for="__nav_2_1_2_3" id="__nav_2_1_2_3_label" tabindex="0">
|
|
985
876
|
<span class="md-nav__icon md-icon"></span>
|
|
986
877
|
</label>
|
|
987
878
|
|
|
988
879
|
</div>
|
|
989
880
|
|
|
990
|
-
<nav class="md-nav" data-md-level="4" aria-labelledby="
|
|
991
|
-
<label class="md-nav__title" for="
|
|
881
|
+
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_2_3_label" aria-expanded="false">
|
|
882
|
+
<label class="md-nav__title" for="__nav_2_1_2_3">
|
|
992
883
|
<span class="md-nav__icon md-icon"></span>
|
|
993
884
|
Upgrading Nautobot from v1.X to v2.0
|
|
994
885
|
</label>
|
|
@@ -1032,7 +923,7 @@
|
|
|
1032
923
|
|
|
1033
924
|
|
|
1034
925
|
|
|
1035
|
-
<input class="md-nav__toggle md-toggle " type="checkbox" id="
|
|
926
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3_2" >
|
|
1036
927
|
|
|
1037
928
|
|
|
1038
929
|
|
|
@@ -1048,14 +939,14 @@
|
|
|
1048
939
|
</a>
|
|
1049
940
|
|
|
1050
941
|
|
|
1051
|
-
<label class="md-nav__link " for="
|
|
942
|
+
<label class="md-nav__link " for="__nav_2_1_2_3_2" id="__nav_2_1_2_3_2_label" tabindex="0">
|
|
1052
943
|
<span class="md-nav__icon md-icon"></span>
|
|
1053
944
|
</label>
|
|
1054
945
|
|
|
1055
946
|
</div>
|
|
1056
947
|
|
|
1057
|
-
<nav class="md-nav" data-md-level="5" aria-labelledby="
|
|
1058
|
-
<label class="md-nav__title" for="
|
|
948
|
+
<nav class="md-nav" data-md-level="5" aria-labelledby="__nav_2_1_2_3_2_label" aria-expanded="false">
|
|
949
|
+
<label class="md-nav__title" for="__nav_2_1_2_3_2">
|
|
1059
950
|
<span class="md-nav__icon md-icon"></span>
|
|
1060
951
|
IPAM Migration Guide
|
|
1061
952
|
</label>
|
|
@@ -1186,10 +1077,10 @@
|
|
|
1186
1077
|
|
|
1187
1078
|
|
|
1188
1079
|
|
|
1189
|
-
<input class="md-nav__toggle md-toggle " type="checkbox" id="
|
|
1080
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3" >
|
|
1190
1081
|
|
|
1191
1082
|
|
|
1192
|
-
<label class="md-nav__link" for="
|
|
1083
|
+
<label class="md-nav__link" for="__nav_2_1_3" id="__nav_2_1_3_label" tabindex="0">
|
|
1193
1084
|
|
|
1194
1085
|
|
|
1195
1086
|
<span class="md-ellipsis">
|
|
@@ -1200,8 +1091,8 @@
|
|
|
1200
1091
|
<span class="md-nav__icon md-icon"></span>
|
|
1201
1092
|
</label>
|
|
1202
1093
|
|
|
1203
|
-
<nav class="md-nav" data-md-level="3" aria-labelledby="
|
|
1204
|
-
<label class="md-nav__title" for="
|
|
1094
|
+
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_3_label" aria-expanded="false">
|
|
1095
|
+
<label class="md-nav__title" for="__nav_2_1_3">
|
|
1205
1096
|
<span class="md-nav__icon md-icon"></span>
|
|
1206
1097
|
Migration
|
|
1207
1098
|
</label>
|
|
@@ -1274,7 +1165,7 @@
|
|
|
1274
1165
|
|
|
1275
1166
|
|
|
1276
1167
|
|
|
1277
|
-
<input class="md-nav__toggle md-toggle " type="checkbox" id="
|
|
1168
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4" >
|
|
1278
1169
|
|
|
1279
1170
|
|
|
1280
1171
|
|
|
@@ -1290,14 +1181,14 @@
|
|
|
1290
1181
|
</a>
|
|
1291
1182
|
|
|
1292
1183
|
|
|
1293
|
-
<label class="md-nav__link " for="
|
|
1184
|
+
<label class="md-nav__link " for="__nav_2_1_4" id="__nav_2_1_4_label" tabindex="0">
|
|
1294
1185
|
<span class="md-nav__icon md-icon"></span>
|
|
1295
1186
|
</label>
|
|
1296
1187
|
|
|
1297
1188
|
</div>
|
|
1298
1189
|
|
|
1299
|
-
<nav class="md-nav" data-md-level="3" aria-labelledby="
|
|
1300
|
-
<label class="md-nav__title" for="
|
|
1190
|
+
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_4_label" aria-expanded="false">
|
|
1191
|
+
<label class="md-nav__title" for="__nav_2_1_4">
|
|
1301
1192
|
<span class="md-nav__icon md-icon"></span>
|
|
1302
1193
|
Configuration
|
|
1303
1194
|
</label>
|
|
@@ -1310,11 +1201,11 @@
|
|
|
1310
1201
|
|
|
1311
1202
|
|
|
1312
1203
|
<li class="md-nav__item">
|
|
1313
|
-
<a href="../../user-guide/administration/configuration/
|
|
1204
|
+
<a href="../../user-guide/administration/configuration/settings.html" class="md-nav__link">
|
|
1314
1205
|
|
|
1315
1206
|
|
|
1316
1207
|
<span class="md-ellipsis">
|
|
1317
|
-
|
|
1208
|
+
Settings
|
|
1318
1209
|
</span>
|
|
1319
1210
|
|
|
1320
1211
|
|
|
@@ -1331,11 +1222,11 @@
|
|
|
1331
1222
|
|
|
1332
1223
|
|
|
1333
1224
|
<li class="md-nav__item">
|
|
1334
|
-
<a href="../../user-guide/administration/configuration/
|
|
1225
|
+
<a href="../../user-guide/administration/configuration/redis.html" class="md-nav__link">
|
|
1335
1226
|
|
|
1336
1227
|
|
|
1337
1228
|
<span class="md-ellipsis">
|
|
1338
|
-
|
|
1229
|
+
Redis
|
|
1339
1230
|
</span>
|
|
1340
1231
|
|
|
1341
1232
|
|
|
@@ -1383,10 +1274,10 @@
|
|
|
1383
1274
|
|
|
1384
1275
|
|
|
1385
1276
|
|
|
1386
|
-
<input class="md-nav__toggle md-toggle " type="checkbox" id="
|
|
1277
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4_4" >
|
|
1387
1278
|
|
|
1388
1279
|
|
|
1389
|
-
<label class="md-nav__link" for="
|
|
1280
|
+
<label class="md-nav__link" for="__nav_2_1_4_4" id="__nav_2_1_4_4_label" tabindex="0">
|
|
1390
1281
|
|
|
1391
1282
|
|
|
1392
1283
|
<span class="md-ellipsis">
|
|
@@ -1397,8 +1288,8 @@
|
|
|
1397
1288
|
<span class="md-nav__icon md-icon"></span>
|
|
1398
1289
|
</label>
|
|
1399
1290
|
|
|
1400
|
-
<nav class="md-nav" data-md-level="4" aria-labelledby="
|
|
1401
|
-
<label class="md-nav__title" for="
|
|
1291
|
+
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_1_4_4_label" aria-expanded="false">
|
|
1292
|
+
<label class="md-nav__title" for="__nav_2_1_4_4">
|
|
1402
1293
|
<span class="md-nav__icon md-icon"></span>
|
|
1403
1294
|
External Authentication
|
|
1404
1295
|
</label>
|
|
@@ -1500,10 +1391,10 @@
|
|
|
1500
1391
|
|
|
1501
1392
|
|
|
1502
1393
|
|
|
1503
|
-
<input class="md-nav__toggle md-toggle " type="checkbox" id="
|
|
1394
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5" >
|
|
1504
1395
|
|
|
1505
1396
|
|
|
1506
|
-
<label class="md-nav__link" for="
|
|
1397
|
+
<label class="md-nav__link" for="__nav_2_1_5" id="__nav_2_1_5_label" tabindex="0">
|
|
1507
1398
|
|
|
1508
1399
|
|
|
1509
1400
|
<span class="md-ellipsis">
|
|
@@ -1514,8 +1405,8 @@
|
|
|
1514
1405
|
<span class="md-nav__icon md-icon"></span>
|
|
1515
1406
|
</label>
|
|
1516
1407
|
|
|
1517
|
-
<nav class="md-nav" data-md-level="3" aria-labelledby="
|
|
1518
|
-
<label class="md-nav__title" for="
|
|
1408
|
+
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_5_label" aria-expanded="false">
|
|
1409
|
+
<label class="md-nav__title" for="__nav_2_1_5">
|
|
1519
1410
|
<span class="md-nav__icon md-icon"></span>
|
|
1520
1411
|
Tools
|
|
1521
1412
|
</label>
|
|
@@ -1588,10 +1479,10 @@
|
|
|
1588
1479
|
|
|
1589
1480
|
|
|
1590
1481
|
|
|
1591
|
-
<input class="md-nav__toggle md-toggle " type="checkbox" id="
|
|
1482
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_6" >
|
|
1592
1483
|
|
|
1593
1484
|
|
|
1594
|
-
<label class="md-nav__link" for="
|
|
1485
|
+
<label class="md-nav__link" for="__nav_2_1_6" id="__nav_2_1_6_label" tabindex="0">
|
|
1595
1486
|
|
|
1596
1487
|
|
|
1597
1488
|
<span class="md-ellipsis">
|
|
@@ -1602,8 +1493,8 @@
|
|
|
1602
1493
|
<span class="md-nav__icon md-icon"></span>
|
|
1603
1494
|
</label>
|
|
1604
1495
|
|
|
1605
|
-
<nav class="md-nav" data-md-level="3" aria-labelledby="
|
|
1606
|
-
<label class="md-nav__title" for="
|
|
1496
|
+
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_1_6_label" aria-expanded="false">
|
|
1497
|
+
<label class="md-nav__title" for="__nav_2_1_6">
|
|
1607
1498
|
<span class="md-nav__icon md-icon"></span>
|
|
1608
1499
|
Guides
|
|
1609
1500
|
</label>
|
|
@@ -1616,11 +1507,32 @@
|
|
|
1616
1507
|
|
|
1617
1508
|
|
|
1618
1509
|
<li class="md-nav__item">
|
|
1619
|
-
<a href="../../user-guide/administration/guides/
|
|
1510
|
+
<a href="../../user-guide/administration/guides/docker.html" class="md-nav__link">
|
|
1620
1511
|
|
|
1621
1512
|
|
|
1622
1513
|
<span class="md-ellipsis">
|
|
1623
|
-
|
|
1514
|
+
Nautobot Docker Images
|
|
1515
|
+
</span>
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
</a>
|
|
1519
|
+
</li>
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
<li class="md-nav__item">
|
|
1531
|
+
<a href="../../user-guide/administration/guides/selinux-troubleshooting.html" class="md-nav__link">
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
<span class="md-ellipsis">
|
|
1535
|
+
SELinux Troubleshooting
|
|
1624
1536
|
</span>
|
|
1625
1537
|
|
|
1626
1538
|
|
|
@@ -1637,11 +1549,11 @@
|
|
|
1637
1549
|
|
|
1638
1550
|
|
|
1639
1551
|
<li class="md-nav__item">
|
|
1640
|
-
<a href="../../user-guide/administration/guides/
|
|
1552
|
+
<a href="../../user-guide/administration/guides/health-checks.html" class="md-nav__link">
|
|
1641
1553
|
|
|
1642
1554
|
|
|
1643
1555
|
<span class="md-ellipsis">
|
|
1644
|
-
Health
|
|
1556
|
+
Health Checks
|
|
1645
1557
|
</span>
|
|
1646
1558
|
|
|
1647
1559
|
|
|
@@ -10046,11 +9958,11 @@
|
|
|
10046
9958
|
<h5 id="required-settings">Required Settings<a class="headerlink" href="#required-settings" title="Permanent link">¶</a></h5>
|
|
10047
9959
|
<p>A newly created configuration includes sane defaults. If you need to customize them, edit your <code>nautobot_config.py</code> and update the following settings as required:</p>
|
|
10048
9960
|
<ul>
|
|
10049
|
-
<li><a href="../../user-guide/administration/configuration/
|
|
10050
|
-
<li><a href="../../user-guide/administration/configuration/
|
|
9961
|
+
<li><a href="../../user-guide/administration/configuration/settings.html#allowed_hosts"><code>ALLOWED_HOSTS</code></a>: This can be set to <code>["*"]</code> for development purposes and must be set if <code>DEBUG=False</code></li>
|
|
9962
|
+
<li><a href="../../user-guide/administration/configuration/settings.html#databases"><code>DATABASES</code></a>: Database connection parameters, if different from the defaults</li>
|
|
10051
9963
|
<li><strong>Redis settings</strong>: Redis configuration requires multiple settings. The defaults should be fine for development.</li>
|
|
10052
|
-
<li><a href="../../user-guide/administration/configuration/
|
|
10053
|
-
<li><a href="../../user-guide/administration/configuration/
|
|
9964
|
+
<li><a href="../../user-guide/administration/configuration/settings.html#debug"><code>DEBUG</code></a>: Set to <code>True</code> to enable verbose exception logging and, if installed, the <a href="https://django-debug-toolbar.readthedocs.io/en/latest/">Django debug toolbar</a></li>
|
|
9965
|
+
<li><a href="../../user-guide/administration/configuration/settings.html#extra-applications"><code>EXTRA_INSTALLED_APPS</code></a>: Optionally provide a list of extra Django apps you may desire to use for development</li>
|
|
10054
9966
|
</ul>
|
|
10055
9967
|
<h2 id="working-in-your-development-environment">Working in your Development Environment<a class="headerlink" href="#working-in-your-development-environment" title="Permanent link">¶</a></h2>
|
|
10056
9968
|
<p>Below are common commands for working your development environment.</p>
|
|
@@ -10237,12 +10149,12 @@
|
|
|
10237
10149
|
<h5 id="useful-unit-test-parameters">Useful Unit Test Parameters<a class="headerlink" href="#useful-unit-test-parameters" title="Permanent link">¶</a></h5>
|
|
10238
10150
|
<p>The <code>invoke unittest</code> command supports a number of optional parameters to influence its behavior. Careful use of these parameters can greatly reduce the time it takes to run and re-run tests during development.</p>
|
|
10239
10151
|
<ul>
|
|
10240
|
-
<li><code>--cache-test-fixtures</code> - Cache <a href="testing.html#factory-caching">test factory data</a> to disk, or if a cache is already present, load from that cache when initializing the test environment. Can significantly improve the initial startup time of the test suite after your first test run.</li>
|
|
10241
10152
|
<li><code>--failfast</code> - Fail as soon as any test failure or error condition is encountered, instead of running to completion.</li>
|
|
10242
|
-
<li><code>--keepdb</code> - Save and reuse the initialized test database between test runs. Can significantly improve the initial startup time of the test suite after your first test run. <strong>Do not use if you're actively making changes to model definitions or migrations.</strong></li>
|
|
10243
10153
|
<li><code>--label <module.path></code> - Only run the specific subset of tests. Can be broad (<code>--label nautobot.core.tests</code>) or specific (<code>--label nautobot.core.tests.test_graphql.GraphQLQueryTestCase</code>).</li>
|
|
10244
10154
|
<li><code>--no-buffer</code> - Allow stdout/stderr output from the test to be seen in your terminal, instead of being hidden. <strong>If you're debugging code with <code>breakpoint()</code>, you should use this option, as otherwise you'll never see the breakpoint happen.</strong></li>
|
|
10245
|
-
<li><code>--
|
|
10155
|
+
<li><code>--no-cache-test-fixtures</code> - Prevent caching <a href="testing.html#factory-caching">test factory data</a> to disk, or if a cache is already present, prevent loading from that cache when initializing the test environment.</li>
|
|
10156
|
+
<li><code>--no-keepdb</code> - Prevent saving and reusing the initialized test database between test runs. <strong>The <code>--no-keepdb</code> option is mandatory if you're actively making changes to model definitions or migrations.</strong></li>
|
|
10157
|
+
<li><code>--parallel</code> - Split the tests across multiple parallel subprocesses. Can greatly reduce the runtime of the entire test suite when used. Auto-detects the number of workers if not specified with <code>--parallel-workers</code>. This parameter is automatically included if no <code>--label</code> is specified.</li>
|
|
10246
10158
|
<li><code>--parallel-workers</code> - Specify the number of workers to use when running tests in parallel. Implies <code>--parallel</code>.</li>
|
|
10247
10159
|
<li><code>--pattern</code> - Only run tests which match the given substring. Can be used multiple times.</li>
|
|
10248
10160
|
<li><code>--skip-docs-build</code> - Skip building/rebuilding the static Nautobot documentation before running the test. Saves some time on reruns when you haven't changed the documentation source files.</li>
|
|
@@ -10250,21 +10162,24 @@
|
|
|
10250
10162
|
</ul>
|
|
10251
10163
|
<h5 id="unit-test-invocation-examples">Unit Test Invocation Examples<a class="headerlink" href="#unit-test-invocation-examples" title="Permanent link">¶</a></h5>
|
|
10252
10164
|
<p>In general, when you first run the Nautobot tests in your local copy of the repository, we'd recommend:</p>
|
|
10253
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-43-1" name="__codelineno-43-1" href="#__codelineno-43-1"></a>invoke unittest
|
|
10165
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-43-1" name="__codelineno-43-1" href="#__codelineno-43-1"></a>invoke unittest
|
|
10254
10166
|
</code></pre></div>
|
|
10255
10167
|
<p>When there are too many cores on the testing machine, you can limit the number of parallel workers:</p>
|
|
10256
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-44-1" name="__codelineno-44-1" href="#__codelineno-44-1"></a>invoke unittest --
|
|
10168
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-44-1" name="__codelineno-44-1" href="#__codelineno-44-1"></a>invoke unittest --parallel-workers 4
|
|
10257
10169
|
</code></pre></div>
|
|
10258
10170
|
<p>On subsequent reruns, you can add the other performance-related options:</p>
|
|
10259
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-45-1" name="__codelineno-45-1" href="#__codelineno-45-1"></a>invoke unittest --
|
|
10260
|
-
<a id="__codelineno-45-2" name="__codelineno-45-2" href="#__codelineno-45-2"></a>invoke unittest --
|
|
10171
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-45-1" name="__codelineno-45-1" href="#__codelineno-45-1"></a>invoke unittest --skip-docs-build
|
|
10172
|
+
<a id="__codelineno-45-2" name="__codelineno-45-2" href="#__codelineno-45-2"></a>invoke unittest --skip-docs-build --label nautobot.core.tests
|
|
10173
|
+
</code></pre></div>
|
|
10174
|
+
<p>When switching between significantly different branches of the code base (e.g. <code>main</code> vs <code>develop</code> vs <code>next</code>), you'll need to for once include the <code>--no-keepdb</code> option so that the test database can be destroyed and recreated appropriately:</p>
|
|
10175
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-46-1" name="__codelineno-46-1" href="#__codelineno-46-1"></a>invoke unittest --no-keepdb
|
|
10261
10176
|
</code></pre></div>
|
|
10262
|
-
<p>
|
|
10263
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-
|
|
10177
|
+
<p>To not use the cached test fixture, you will need to include the <code>--no-cache-test-fixtures</code> flag</p>
|
|
10178
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-47-1" name="__codelineno-47-1" href="#__codelineno-47-1"></a>invoke unittest --no-cache-test-fixtures
|
|
10264
10179
|
</code></pre></div>
|
|
10265
10180
|
<p>To limit the test to a specific pattern or label, you can use the <code>--label</code> and <code>--pattern</code> options:</p>
|
|
10266
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-
|
|
10267
|
-
<a id="__codelineno-
|
|
10181
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-48-1" name="__codelineno-48-1" href="#__codelineno-48-1"></a>invoke unittest --verbose --skip-docs-build --label nautobot.core.tests.dcim.test_views.DeviceTestCase
|
|
10182
|
+
<a id="__codelineno-48-2" name="__codelineno-48-2" href="#__codelineno-48-2"></a>invoke unittest --verbose --skip-docs-build --pattern Controller
|
|
10268
10183
|
</code></pre></div>
|
|
10269
10184
|
<h4 id="integration-tests">Integration Tests<a class="headerlink" href="#integration-tests" title="Permanent link">¶</a></h4>
|
|
10270
10185
|
<p>Integration tests are automated tests written and run to ensure that the Nautobot application behaves as expected when being used as it would be in practice. By contrast to unit tests, where individual units of code are being tested, integration tests rely upon the server code actually running, and web UI clients or API clients to make real connections to the service to exercise actual workflows, such as navigating to the login page, filling out the username/passwords fields, and clicking the "Log In" button.</p>
|
|
@@ -10469,8 +10384,8 @@
|
|
|
10469
10384
|
</table>
|
|
10470
10385
|
<h2 id="submitting-pull-requests">Submitting Pull Requests<a class="headerlink" href="#submitting-pull-requests" title="Permanent link">¶</a></h2>
|
|
10471
10386
|
<p>Once you're happy with your work and have verified that all tests pass, commit your changes and push it upstream to your fork. Always provide descriptive (but not excessively verbose) commit messages. When working on a specific issue, be sure to reference it.</p>
|
|
10472
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-
|
|
10473
|
-
<a id="__codelineno-
|
|
10387
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-49-1" name="__codelineno-49-1" href="#__codelineno-49-1"></a>git commit -m "Closes #1234: Add IPv5 support"
|
|
10388
|
+
<a id="__codelineno-49-2" name="__codelineno-49-2" href="#__codelineno-49-2"></a>git push origin
|
|
10474
10389
|
</code></pre></div>
|
|
10475
10390
|
<p>Once your fork has the new commit, submit a <a href="https://github.com/nautobot/nautobot/compare">pull request</a> to the Nautobot repo to propose the changes. Be sure to provide a detailed accounting of the changes being made and the reasons for doing so.</p>
|
|
10476
10391
|
<p>Once submitted, a maintainer will review your pull request and either merge it or request changes. If changes are needed, you can make them via new commits to your fork: The pull request will update automatically.</p>
|
|
@@ -10482,11 +10397,11 @@
|
|
|
10482
10397
|
<p>Below are common issues you might encounter in your development environment and how to address them.</p>
|
|
10483
10398
|
<h3 id="fatal-sorry-too-many-clients-already">FATAL: sorry, too many clients already<a class="headerlink" href="#fatal-sorry-too-many-clients-already" title="Permanent link">¶</a></h3>
|
|
10484
10399
|
<p>When using <code>nautobot-server runserver</code> to do development you might run into a traceback that looks something like this:</p>
|
|
10485
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-
|
|
10486
|
-
<a id="__codelineno-
|
|
10400
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-50-1" name="__codelineno-50-1" href="#__codelineno-50-1"></a>Exception Type: OperationalError at /extras/tags/
|
|
10401
|
+
<a id="__codelineno-50-2" name="__codelineno-50-2" href="#__codelineno-50-2"></a>Exception Value: FATAL: sorry, too many clients already
|
|
10487
10402
|
</code></pre></div>
|
|
10488
10403
|
<p>The <code>runserver</code> development server is multi-threaded by default, which means that every request is creating its own connection. If you are doing some local testing or development that is resulting in a lot of connections to the database, pass <code>--nothreading</code> to the runserver command to disable threading:</p>
|
|
10489
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-
|
|
10404
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-51-1" name="__codelineno-51-1" href="#__codelineno-51-1"></a>nautobot-server runserver --nothreading
|
|
10490
10405
|
</code></pre></div>
|
|
10491
10406
|
|
|
10492
10407
|
|