Updated docs

Author: Rod Anami

CHANGELOG.md

@@ -5,7 +5,12 @@
 * `0.4.10`
   * Upgraded development env to Vault server `1.11.0`
   * Upgraded all dependencies (`Axios` and `Jest`)
-  * Improved KV secret engine tests
+  * Improved KV secret engine assertions
+  * Added *AD secret engine* functions:
+    * `setADConfig`
+    * `readADConfig`
+    * `updateADConfig`
+    * `deleteADConfig`
 
 * `0.4.9`
   * Upgraded development env to Vault server `1.10.2`

README.md

@@ -226,19 +226,20 @@ Check below docs for more information on specific function groups.
 
 ### List of functions available
 
-| **Group** | **Link** |
-|:---------------------------------------|:--------------:|
-| **AppRole** auth method API endpoints - /auth/approle | [Doc file](/docs/AppRole-Functions.md) |
-| **LDAP** auth method API endpoints - /auth/ldap | [Doc file](/docs/LDAP-Functions.md) |
-| **Kubernetes** auth method API endpoints - /auth/kubernetes | [Doc file](/docs/Kubernetes-Functions.md) |
-| **KV v2** secret engine API endpoints | [Doc file](/docs/KVV2-Functions.md) |
-| **PKI secret** engine API endpoints | [Doc file](/docs/PKI-Functions.md) |
-| **System Backend** API endpoints - General | [Doc file](/docs/Sys-Functions.md) |
-| **System Backend** API endpoints - SEAL operations | [Doc file](/docs/Sys-Seal-Functions.md) |
-| **TLS Certificate** auth method API endpoints - /auth/cert | [Doc file](/docs/TLS-Cert-Functions.md) |
-| **Token** auth method API endpoints - /auth/token | [Doc file](/docs/Token-Functions.md) |
-| **Userpass** auth method API endpoints - /auth/userpass | [Doc file](/docs/Userpass-Functions.md) |
-|  |  |
+| **Group** | **Type** | **Default mount point** | **Link** |
+|:------------------|:------------------|:------------------|:--------------:|
+| **Active Directory** (AD) | Secret engine | `/ad` | [Doc file](/docs/AD-Functions.md) |
+| **AppRole** | Auth method | `/auth/approle` | [Doc file](/docs/AppRole-Functions.md) |
+| **LDAP** | Auth method | `/auth/ldap` | [Doc file](/docs/LDAP-Functions.md) |
+| **Kubernetes** | Auth method | `/auth/kubernetes` | [Doc file](/docs/Kubernetes-Functions.md) |
+| **KV v2** | Secret engine | `/kv` | [Doc file](/docs/KVV2-Functions.md) |
+| **PKI** | Secret engine | `/pki` | [Doc file](/docs/PKI-Functions.md) |
+| **System Backend** | System | General operations | [Doc file](/docs/Sys-Functions.md) |
+| **System Backend** | System | SEAL operations | [Doc file](/docs/Sys-Seal-Functions.md) |
+| **TLS Certificate** | Auth method | `/auth/cert` | [Doc file](/docs/TLS-Cert-Functions.md) |
+| **Token** | Auth method | `/auth/token` | [Doc file](/docs/Token-Functions.md) |
+| **Userpass** | Auth method | `/auth/userpass` | [Doc file](/docs/Userpass-Functions.md) |
+|  |  |  |  |
 
 
 ### Coverage and Limitations
@@ -263,6 +264,7 @@ The following HashiCorp Vault API endpoints are currently covered:
 
 | **Engine** | **Coverage status** |
 |:------------|:-----------|
+| [Active Directory (AD)](https://www.vaultproject.io/api-docs/secret/ad) | `Config only` |
 | [KV Version 2](https://www.vaultproject.io/api-docs/secret/kv/kv-v2) | `All endpoints` |
 | [PKI](https://www.vaultproject.io/api-docs/secret/pki) | `Most of them` |
 | | |

docker/docker-compose.yaml

@@ -1,7 +1,7 @@
 version: '3'
 services:
   vault:
-    image: vault:1.10.2
+    image: vault:1.11.0
     container_name: my-vault
     ports:
       - "8200:8200"
@@ -15,7 +15,7 @@ services:
       - ./volumes/certs:/vault/certs
     cap_add:
       - IPC_LOCK
-    entrypoint: vault server -config=/vault/config/vault.json
+    entrypoint: vault server -config=/vault/config/vault.hcl
 networks:
     default:
         driver: bridge

docker/volumes/config/vault.hcl

@@ -0,0 +1,17 @@
+
+storage "file" {
+  path = "/vault/file"
+}
+
+listener "tcp" {
+  address     = "0.0.0.0:8200"
+  tls_disable = false
+  tls_cert_file = "/vault/certs/vault.crt"
+  tls_key_file = "/vault/certs/vault.key"
+}
+
+ui = true
+disable_mlock = true
+max_lease_ttl =  "760h"
+default_lease_ttl = "760h"
+api_addr = "https://127.0.0.1:8200"

docker/volumes/config/vault.json

@@ -0,0 +1,45 @@
+# Hashi Vault JS
+
+## AD Functions List
+
+* setADConfig(token, data, mount)
+
+```javascript
+/**
+ * @param {String<required>} token
+ * @param {Object<required>} data
+ * @param {String} mount
+ * @returns {Promise<Object>}
+ */
+```
+
+* updateADConfig(token, data, mount)
+
+```javascript
+/**
+ * @param {String<required>} token
+ * @param {Object<required>} data
+ * @param {String} mount
+ * @returns {Promise<Object>}
+ */
+```
+
+* readADConfig(token, mount)
+
+```javascript
+/**
+ * @param {String<required>} token
+ * @param {String} mount
+ * @returns {Promise<Object>}
+ */
+```
+
+* deleteADConfig(token, mount)
+
+```javascript
+/**
+ * @param {String<required>} token
+ * @param {String} mount
+ * @returns {Promise<Object>}
+ */
+```