diff --git a/lib/openshift-rest-client.js b/lib/openshift-rest-client.js index a42dadd..5e36766 100644 --- a/lib/openshift-rest-client.js +++ b/lib/openshift-rest-client.js @@ -61,12 +61,13 @@ const spec = JSON.parse(zlib.gunzipSync(fs.readFileSync(path.join(__dirname, 'sp * Builds the rest client based on provided or default kubernetes configuration. * * @param {object} [settings] - settings object for the openshiftClient function - * @param {string} [settings.url] - Openshift cluster url - * @param {string} [settings.authUrl] - Openshift Basic auth url - * @param {object} [settings.auth] - - * @param {string} [settings.auth.username] - username to authenticate to Openshift - * @param {string} [settings.auth.password] - password to authenticate to Openshift - * @param {boolean} [settings.insecureSkipTlsVerify] - flag to ignore TLS verification + * @param {object} [settings.config] - custom config object + * @param {string} [settings.config.url] - Openshift cluster url + * @param {string} [settings.config.authUrl] - Openshift Basic auth url + * @param {object} [settings.config.auth] - + * @param {string} [settings.config.auth.username] - username to authenticate to Openshift + * @param {string} [settings.config.auth.password] - password to authenticate to Openshift + * @param {boolean} [settings.config.insecureSkipTlsVerify] - flag to ignore TLS verification * @returns {Promise} Returns the Rest Client */ async function openshiftClient (settings = {}) {