Skip to content

Commit

Permalink
docs: updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bl4ko committed Mar 4, 2024
1 parent c31fa71 commit 2ce021e
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Currently, the supported external data sources types are:
- [`ovirt`](https://www.ovirt.org/)
- [`vmware`](https://www.vmware.com/products/vcenter.html)
- [`dnac`](https://www.cisco.com/site/us/en/products/networking/catalyst-center/index.html)
- [`proxmox`](https://www.proxmox.com/en/)

> [!WARNING]
> **This project is still under heavy development, use with caution.**
> Works with `netbox>=3.7.x`.

## Configuration

Netbox-ssot is configured via a single yaml file.
Expand Down Expand Up @@ -84,16 +84,26 @@ netbox:
hostname: "netbox.example.com"
port: 443
timeout: 30
sourcePriority: ["Test oVirt", "prodvmware", "dnacenter", "testvmware"] # Not required, but recommended
sourcePriority: ["olvm", "prodvmware", "prodprox", "dnacenter", "testvmware"] # Not required, but recommended

source:
- name: "Test oVirt"
type: "ovirt"
hostname: "ovirt.example.com"
- name: olvm
type: ovirt
hostname: ovirt.example.com
port: 443
username: "admin"
password: "topsecret"

- name: prodprox
type: proxmox
username: svc@pve
password: changeme
hostname: 192.168.1.254
port: 8006
validateCert: false
clusterSiteRelations:
- .* = Site

- name: prodvmware
type: vmware
hostname: vcenter.example.com
Expand Down Expand Up @@ -129,7 +139,6 @@ source:
- .* = MyTenant
```
## Deployment
### Via docker
Expand Down

0 comments on commit 2ce021e

Please sign in to comment.