docs(distro-vertx) Few config comment tweaks.
MODIFY
distro/vertx/src/main/resources/overlay/configs/conf-es.json
distro/vertx/src/main/resources/overlay/configs/conf-es.json
// }
// },
- // API authentication; presently just BASIC auth.
+ // Gateway API Authentication. See documentation for further possibilities..
"auth": {
"type": "keycloak",
"config": {
"flowType": "PASSWORD",
"requiredRole": "realm:apipublisher",
// Paste and overwrite your Keycloak config here.
- // Remember to change to *confidential client* type in KC console. TODO.
- // See: https://msavy.gitbooks.io/apiman-production-guide/content/production-guide/gateway/vertx.html#_configuring_keycloak_authentication_for_the_gateway_api
"realm": "apiman",
"realm-public-key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxyG61ohrfJQKNmDA/ePZtqZVpPXjwn3k3T+iWiTvMsxW2+WlnqIEmL5qZ09DMhBH9r50WZRO2gVoCb657Er9x0vfD6GNf/47XU2y33TX8axhP+hSwkv/VViaDlu4jQrfgPWz/FXMjWIZxg1xQS+nOBF2ScCRYWNQ/ZnUNnvrq8dGC2/AlyeYcgDUOdwlJuvgkGlF0QoVPQiRPurR3RwlG+BjL8JB3hbaAZhdJqwqApmGQbcpgLj2tODnlrZnEAp5cPPU/lgqCE1OOp78BAEiE91ZLPl/+D8qDHk+Maz0Io3bkeRZMXPpvtbL3qN+3GlF8Yz264HDSsTNrH+nd19tFQIDAQAB",
"auth-server-url": "http://localhost:8080/auth",
"ssl-required": "none",
"resource": "apiman-gateway-api",
+ // A limitation in the current OAuth2 implementation means a credentials section is required
+ // even if your client is not set to "confidential". Leave this dummy section if you're using non-confidential.
"credentials": {
"secret": "217b725d-7790-47a7-a3fc-5cf31f92a8db"
}
}
},
- // When reporting an API's endpoint, prefer secure (i.e. https)
+ // When reporting an API's endpoint, prefer secure (i.e. https). You should probably change this after enabling HTTPS.
"preferSecure": false
}

MODIFY
distro/vertx/src/main/resources/overlay/configs/conf-headless-es.json
distro/vertx/src/main/resources/overlay/configs/conf-headless-es.json
"registry": {
"class": "io.apiman.gateway.engine.vertx.polling.URILoadingRegistry",
"config": {
- // Path to your apiman JSON config; see data format @ TODO <link to docs>
+ // Path to your apiman JSON config; refer to apiman's documentation for format description.
// Supports: file, HTTP & HTTPS.
"configUri": "file:///path/to/my/json/config.json",
// For HTTP/HTTPS auth is supported: BASIC, OAUTH2, KEYCLOAKOAUTH2
- // For more detail see: <link to docs> TODO
+ // For more detail refer to the apiman documentation.
"auth": "NONE"
}
},
// }
// },
- // API authentication; presently just BASIC auth.
+ // Gateway API Authentication. See documentation for further possibilities.
"auth": {
"type": "keycloak",
"config": {
"flowType": "PASSWORD",
"requiredRole": "realm:apipublisher",
// Paste and overwrite your Keycloak config here.
- // Remember to change to *confidential client* type in KC console. TODO
- // See: https://msavy.gitbooks.io/apiman-production-guide/content/production-guide/gateway/vertx.html#_configuring_keycloak_authentication_for_the_gateway_api
"realm": "apiman",
"realm-public-key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxyG61ohrfJQKNmDA/ePZtqZVpPXjwn3k3T+iWiTvMsxW2+WlnqIEmL5qZ09DMhBH9r50WZRO2gVoCb657Er9x0vfD6GNf/47XU2y33TX8axhP+hSwkv/VViaDlu4jQrfgPWz/FXMjWIZxg1xQS+nOBF2ScCRYWNQ/ZnUNnvrq8dGC2/AlyeYcgDUOdwlJuvgkGlF0QoVPQiRPurR3RwlG+BjL8JB3hbaAZhdJqwqApmGQbcpgLj2tODnlrZnEAp5cPPU/lgqCE1OOp78BAEiE91ZLPl/+D8qDHk+Maz0Io3bkeRZMXPpvtbL3qN+3GlF8Yz264HDSsTNrH+nd19tFQIDAQAB",
"auth-server-url": "http://localhost:8080/auth",
"ssl-required": "none",
"resource": "apiman-gateway-api",
+ // A limitation in the current OAuth2 implementation means a credentials section is required
+ // even if your client is not set to "confidential". Leave this dummy section if you're using non-confidential.
"credentials": {
"secret": "217b725d-7790-47a7-a3fc-5cf31f92a8db"
}
}
},
- // When reporting an API's endpoint, prefer secure (i.e. https)
+ // When reporting an API's endpoint, prefer secure (i.e. https). You should probably change this after enabling HTTPS.
"preferSecure": false
}

docs(distro-vertx) Few config comment tweaks.