summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTibor Král <tibor.kral@pantheon.tech>2019-01-18 14:01:43 +0100
committerMichal Cmarada <mcmarada@cisco.com>2019-01-18 14:03:58 +0100
commitd10368dffa17254096c99f64d7e1d77644f50a6d (patch)
tree3131f90cfb711ef9a9610cd2eb38f5e1d3762817
parentc277b4eaa7abd1d3242384cd56dfb5d3bd84fb21 (diff)
Update IPSec documentation
- Add missing IpSec links to userguide - update Readme.adoc - additional request to postman collection Change-Id: I233b0f7a58acbfab9b8b587bbd2f20566709e52f Signed-off-by: Tibor Král <tibor.kral@pantheon.tech> Signed-off-by: Michal Cmarada <mcmarada@cisco.com>
-rw-r--r--ipsec/Ipsec_postman_collection.json35
-rw-r--r--ipsec/asciidoc/Readme.adoc8
-rw-r--r--release-notes/src/main/asciidoc/user_guide/user_guide.adoc6
3 files changed, 47 insertions, 2 deletions
diff --git a/ipsec/Ipsec_postman_collection.json b/ipsec/Ipsec_postman_collection.json
index cbe0759d3..425cfe8d9 100644
--- a/ipsec/Ipsec_postman_collection.json
+++ b/ipsec/Ipsec_postman_collection.json
@@ -156,6 +156,41 @@
"response": []
},
{
+ "name": "Add Ikev2 Local Key",
+ "request": {
+ "method": "PUT",
+ "header": [
+ {
+ "key": "Authorization",
+ "value": "Basic YWRtaW46YWRtaW4="
+ },
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n\t\"ike-global-configuration\": {\n\t\t\"local-key-file\":\"/home/localadmin/certs/client-key.pem\"\n\t}\n}\n"
+ },
+ "url": {
+ "raw": "http://localhost:8183/restconf/config/hc2vpp-ietf-ipsec:ikev2/ike-global-configuration",
+ "protocol": "http",
+ "host": [
+ "localhost"
+ ],
+ "port": "8183",
+ "path": [
+ "restconf",
+ "config",
+ "hc2vpp-ietf-ipsec:ikev2",
+ "ike-global-configuration"
+ ]
+ }
+ },
+ "response": []
+ },
+ {
"name": "Add Ikev2 profile SHARED-KEY",
"request": {
"method": "PUT",
diff --git a/ipsec/asciidoc/Readme.adoc b/ipsec/asciidoc/Readme.adoc
index f56b20a55..8eaa0cfb8 100644
--- a/ipsec/asciidoc/Readme.adoc
+++ b/ipsec/asciidoc/Readme.adoc
@@ -1,3 +1,9 @@
= ipsec-aggregator
-Overview of ipsec-aggregator
+This is a Honeycomb plugin providing mapping code between HC and IpSec Plugin APIs.
+
+== Usage
+
+Refer to Ipsec_postman_collection.json for sample requests and the wiki page for additional info:
+
+ https://wiki.fd.io/view/VPP/IPSec_and_IKEv2
diff --git a/release-notes/src/main/asciidoc/user_guide/user_guide.adoc b/release-notes/src/main/asciidoc/user_guide/user_guide.adoc
index 3330ba4af..428e2db06 100644
--- a/release-notes/src/main/asciidoc/user_guide/user_guide.adoc
+++ b/release-notes/src/main/asciidoc/user_guide/user_guide.adoc
@@ -55,6 +55,8 @@ Honeycomb's configuration files present within its distribution:
** {project-git-web}/mpls/api/src/main/yang?h={project-branch}[MPLS YANG models]
* SRv6 plugin
** {project-git-web}/srv6/srv6-api/src/main/yang?h={project-branch}[SRv6 YANG models]
+* IpSec plugin
+** {project-git-web}/ipsec/ipsec-api/src/main/yang?h={project-branch}[IpSec YANG models]
=== POSTMAN collections
@@ -96,4 +98,6 @@ collection]
** {project-git-web}/bgp/bgp-prefix-sid/bgp_prefix_sid_postman_collection.json?h={project-branch}[BGP Prefix SID postman collection].
* SRv6 plugin
** {project-git-web}/srv6/srv6_localsid_postman_collection.json?h={project-branch}[SRv6 local SID postman collection].
-** {project-git-web}/srv6/srv6_policy_postman_collection.json?h={project-branch}[SRv6 policy SID postman collection]. \ No newline at end of file
+** {project-git-web}/srv6/srv6_policy_postman_collection.json?h={project-branch}[SRv6 policy SID postman collection].
+* IpSec plugin
+** {project-git-web}/ipsec/Ipsec_postman_collection.json?h={project-branch}[IpSec postman collection].