From 7c2c3e08eb1e60cb9e7291140db52cd9b2bbe54e Mon Sep 17 00:00:00 2001
From: Claudio Pisa <claudio.pisa@garr.it>
Date: Tue, 20 Aug 2019 12:35:53 +0000
Subject: [PATCH] update documentation
---
README.md | 15 +++++++++++----
config.yaml | 2 +-
metadata.yaml | 7 ++++---
3 files changed, 16 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 92db3a2..5248a6a 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,13 @@
# Overview
-This charm sets the default gateway in /etc/network/interfaces.
+This charm overrides the default gateway with the one specified by the gateway
+configuration option.
-It is a subordinate charm.
+The charm will try to create a "backup" of the existing default gateway by
+setting its metric to 1.
+
+It is a subordinate charm, thus it needs to be deployed along with other
+services.
# Usage
@@ -11,11 +16,13 @@ Step by step instructions on using the charm:
juju deploy servicename
juju add-relation defaultgw servicename
-## Known Limitations and Issues
+# Known Limitations and Issues
# Configuration
- gateway IP or CIDR of default gateway in /etc/network/interfaces. E.g.: 10.10.10.1/24
+* `gateway`
+
+ IP of default gateway. e.g.: 10.10.10.1
# Contact Information
diff --git a/config.yaml b/config.yaml
index 20a2fca..0ed6839 100644
--- a/config.yaml
+++ b/config.yaml
@@ -2,4 +2,4 @@ options:
gateway:
type: string
default: ""
- description: "IP or CIDR of default gateway in /etc/network/interfaces. E.g.: 10.10.10.1/24"
+ description: "IP of default gateway. e.g.: 10.10.10.1"
diff --git a/metadata.yaml b/metadata.yaml
index 65e741f..b8330c7 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -1,9 +1,10 @@
subordinate: true
name: defaultgw
-summary: This charm set default gateway in /etc/network/interfaces
-maintainer: gianni.marzulli@garr.it
+summary: Subordinate charm to override the default gateway
+maintainer: cloud-support@garr.it
description: |
- This charm sets the default gateway in /etc/network/interfaces
+ This charm sets the default gateway as configured by the gateway
+ configuration option.
tags:
- network
series:
--
GitLab