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 <[email protected]>
Signed-off-by: Michal Cmarada <[email protected]>

diff --git a/ipsec/Ipsec_postman_collection.json b/ipsec/Ipsec_postman_collection.json
index cbe0759..425cfe8 100644 (file)
--- a/ipsec/Ipsec_postman_collection.json
+++ b/ipsec/Ipsec_postman_collection.json
@@ -155,6 +155,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": {

diff --git a/ipsec/asciidoc/Readme.adoc b/ipsec/asciidoc/Readme.adoc
index f56b20a..8eaa0cf 100644 (file)
--- 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 3330ba4..428e2db 100644 (file)
--- 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].