Skip to content

Commit

Permalink
Merge pull request #542 from nautobot/patch-update_docs
Browse files Browse the repository at this point in the history
Update Docs
  • Loading branch information
jdrew82 authored Sep 30, 2024
2 parents 447e9d0 + e3d0e03 commit 81093b2
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 2 deletions.
1 change: 1 addition & 0 deletions changes/542.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Correct documentation for ACI integration and add missing DNA Center installation documentation.
7 changes: 6 additions & 1 deletion docs/admin/integrations/aci_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ PLUGINS_CONFIG = {

All APIC specific settings have been updated to use the Controller and related ExternalIntegration objects. The ExternalIntegration object that is assigned to the Controller will define the APIC base URL, user credentials, and SSL verification. It will also have a `tenant_prefix` key in the `extra_config` section of the ExternalIntegration to define the Tenant prefix.

The `aci_apics` setting from the `nautobot_config.py` file is no longer used and any configuration found for it will be automatically migrated into a Controller and an ExternalIntegration object.
The `aci_apics` setting from the `nautobot_config.py` file is no longer used. Any configuration found for the APICs that were defined in `aci_apics` will need to be manually input into the Nautobot UI to create the required ExternalIntegration and Controller objects.

## Nautobot Objects Affected by Settings

Expand All @@ -82,14 +82,19 @@ There are example YAML files for a few common switch models in `nautobot_ssot/in
When upgrading from `nautobot-plugin-ssot-aci` app, it's necessary to [avoid conflicts](../upgrade.md#potential-apps-conflicts).

- Uninstall the old app:

```shell
pip uninstall nautobot-plugin-ssot-aci
```

- Upgrade the app with required extras:

```shell
pip install --upgrade nautobot-ssot[aci]
```

- Fix `nautobot_config.py` by removing `nautobot_ssot_aci` from `PLUGINS` and merging app configuration into `nautobot_ssot`:

```python
PLUGINS = [
"nautobot_ssot",
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/integrations/dna_center_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ pip install nautobot-ssot[dna_center]

## Configuration

Connecting to a DNA Center instance is handled through the Nautobot [Controller](https://docs.nautobot.com/projects/core/en/stable/development/core/controllers/) object. There is an expectation that you will create an [ExternalIntegration](https://docs.nautobot.com/projects/core/en/stable/user-guide/platform-functionality/externalintegration/) with the requisite connection information for your DNA Center instance attached to that Controller object. All imported Devices will be associated to a [ControllerManagedDeviceGroup](https://docs.nautobot.com/projects/core/en/stable/user-guide/core-data-model/dcim/controllermanageddevicegroup/) that is found or created during each Job run. It will update the group name to be "\<Controller name\> Managed Devices" if it exists. When running the Sync Job you will specify which DNA Center Controller instance you wish to synchronize with. Other behaviors for the integration can be controlled with the following settings:
Connecting to a DNA Center instance is handled through the Nautobot [Controller](https://docs.nautobot.com/projects/core/en/stable/development/core/controllers/) object. There is an expectation that you will create an [ExternalIntegration](https://docs.nautobot.com/projects/core/en/stable/user-guide/platform-functionality/externalintegration/) with the requisite connection information for your DNA Center instance attached to that Controller object. All imported Devices will be associated to a [ControllerManagedDeviceGroup](https://docs.nautobot.com/projects/core/en/stable/user-guide/core-data-model/dcim/controllermanageddevicegroup/) that is found or created during each Job run. It will update the group name to be "<Controller name\> Managed Devices" if it exists. When running the Sync Job you will specify which DNA Center Controller instance you wish to synchronize with. Other behaviors for the integration can be controlled with the following settings:

| Configuration Variable | Type | Usage | Default |
| --------------------------------------------------- | ------- | ---------------------------------------------------------- | -------------------- |
Expand Down
1 change: 1 addition & 0 deletions docs/admin/integrations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This Nautobot app supports the following integrations:
- [Cisco ACI](./aci_setup.md)
- [Arista CloudVision](./aristacv_setup.md)
- [Device42](./device42_setup.md)
- [Cisco DNA Center](./dna_center_setup.md)
- [Infoblox](./infoblox_setup.md)
- [IPFabric](./ipfabric_setup.md)
- [Itential](./itential_setup.md)
Expand Down

0 comments on commit 81093b2

Please sign in to comment.