From d10ac9b4a7a37ad9a441f81176f997df95052829 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 5 Dec 2023 14:03:38 -0500 Subject: [PATCH] Closes #12623: Document need for core.sync_datasource permission --- docs/features/synchronized-data.md | 4 +++- docs/integrations/synchronized-data.md | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/features/synchronized-data.md b/docs/features/synchronized-data.md index f266519b66..a070d0ce1b 100644 --- a/docs/features/synchronized-data.md +++ b/docs/features/synchronized-data.md @@ -10,7 +10,6 @@ To enable remote data synchronization, the NetBox administrator first designates (Local disk paths are considered "remote" in this context as they exist outside NetBox's database. These paths could also be mapped to external network shares.) - !!! info Data backends which connect to external sources typically require the installation of one or more supporting Python libraries. The Git backend requires the [`dulwich`](https://www.dulwich.io/) package, and the S3 backend requires the [`boto3`](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) package. These must be installed within NetBox's environment to enable these backends. @@ -23,3 +22,6 @@ The following NetBox models can be associated with replicated data files: * Export templates Once a data has been designated for a local instance, its data will be replaced with the content of the replicated file. When the replicated file is updated in the future (via synchronization jobs), the local instance will be flagged as having out-of-date data. A user can then synchronize these objects individually or in bulk to effect the update. This two-stage process ensures that automated synchronization tasks do not immediately affect production data. + +!!! note "Permissions" + A user must be assigned the `core.sync_datasource` permission in order to synchronize local files from a remote data source. diff --git a/docs/integrations/synchronized-data.md b/docs/integrations/synchronized-data.md index 805cbe15bc..d72501fd54 100644 --- a/docs/integrations/synchronized-data.md +++ b/docs/integrations/synchronized-data.md @@ -2,6 +2,9 @@ Some NetBox models support automatic synchronization of certain attributes from remote [data sources](../models/core/datasource.md), such as a git repository hosted on GitHub or GitLab. Data from the authoritative remote source is synchronized locally in NetBox as [data files](../models/core/datafile.md). +!!! note "Permissions" + A user must be assigned the `core.sync_datasource` permission in order to synchronize local files from a remote data source. This is accomplished by creating a permission for the "Core > Data Source" object type with the `sync` action, and assigning it to the desired user and/or group. + The following features support the use of synchronized data: * [Configuration templates](../features/configuration-rendering.md)