From 372d7125a184663a6a7dd8456086cb534c4ab797 Mon Sep 17 00:00:00 2001 From: Pim van Pelt Date: Sun, 6 Jul 2025 17:55:11 +0200 Subject: [PATCH] Update path to etc/ --- README.md | 10 +++++----- docs/DETAILS.md | 18 +++++++++--------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b407e15..613fca6 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ make build 1. **Create configuration files**: - **Device types** (`yaml/00-device-types.yaml`): + **Device types** (`etc/00-device-types.yaml`): ```yaml types: srlinux: @@ -40,7 +40,7 @@ make build - show running-config ``` - **Device config** (`yaml/config.yaml`): + **Device config** (`etc/config.yaml`): ```yaml devices: asw100: @@ -55,13 +55,13 @@ make build ```bash # Backup all devices (multiple YAML files are automatically merged) -ipng-router-backup --yaml yaml/00-device-types.yaml --yaml yaml/config.yaml --output-dir /backup +ipng-router-backup --yaml etc/00-device-types.yaml --yaml etc/config.yaml --output-dir /backup # Or use wildcards -ipng-router-backup --yaml yaml/*.yaml --output-dir /backup +ipng-router-backup --yaml etc/*.yaml --output-dir /backup # Backup specific devices -ipng-router-backup --yaml yaml/*.yaml --host asw100 --output-dir /backup +ipng-router-backup --yaml etc/*.yaml --host asw100 --output-dir /backup ``` 3. **Check output**: diff --git a/docs/DETAILS.md b/docs/DETAILS.md index d68a40e..d4d50bf 100644 --- a/docs/DETAILS.md +++ b/docs/DETAILS.md @@ -102,7 +102,7 @@ The tool automatically merges multiple YAML files using the mergo library. Files **Example file structure:** ``` /etc/ipng-router-backup/ -├── yaml/ +├── etc/ │ ├── 00-device-types.yaml # Device type definitions (loaded first) │ ├── 10-production.yaml # Production device definitions │ ├── 20-staging.yaml # Staging device definitions @@ -114,12 +114,12 @@ The tool automatically merges multiple YAML files using the mergo library. Files 1. **Load multiple files with automatic merging:** ```bash - ipng-router-backup --yaml yaml/00-device-types.yaml --yaml yaml/10-production.yaml + ipng-router-backup --yaml etc/00-device-types.yaml --yaml etc/10-production.yaml ``` 2. **Use wildcards for directory-based loading:** ```bash - ipng-router-backup --yaml yaml/*.yaml + ipng-router-backup --yaml etc/*.yaml ``` 3. **Override configurations per environment:** @@ -390,7 +390,7 @@ For large deployments, organize configurations using multiple YAML files with au **Environment-based structure:** ```bash network-backup/ -├── yaml/ +├── etc/ │ ├── 00-device-types.yaml # All device types (loaded first) │ ├── 10-common.yaml # Common settings │ ├── 20-production.yaml # Production devices @@ -403,7 +403,7 @@ network-backup/ └── maintenance.yaml # Maintenance mode settings ``` -**Device types** (`yaml/00-device-types.yaml`): +**Device types** (`etc/00-device-types.yaml`): ```yaml types: srlinux: @@ -419,7 +419,7 @@ types: - show running-config ``` -**Production devices** (`yaml/20-production.yaml`): +**Production devices** (`etc/20-production.yaml`): ```yaml devices: prod-asw100: @@ -438,13 +438,13 @@ devices: **Usage examples:** ```bash # Load all standard configs -ipng-router-backup --yaml yaml/*.yaml +ipng-router-backup --yaml etc/*.yaml # Load with environment-specific overrides -ipng-router-backup --yaml yaml/*.yaml --yaml overrides/emergency.yaml +ipng-router-backup --yaml etc/*.yaml --yaml overrides/emergency.yaml # Load only specific environments -ipng-router-backup --yaml yaml/00-device-types.yaml --yaml yaml/20-production.yaml +ipng-router-backup --yaml etc/00-device-types.yaml --yaml etc/20-production.yaml ``` ### Integration with Git