openshift-rest-client

6.0.0
Need help reading this?

getAuthUrlFromOCP

This method allows to retrieve automatically the authorization endpoint from the api compatible with OCP 3.x and OCP 4.x

getAuthUrlFromOCP
Parameters
url (string) openshift platform api url
insecureSkipTlsVerify (boolean = true) validate ssl

openshiftClient

Builds the rest client based on provided or default kubernetes configuration.

openshiftClient(settings: object?): Promise
Parameters
settings (object? = {}) settings object for the openshiftClient function
Name Description
settings.loadSpecFromCluster boolean? load the api spec from a remote cluster. Defaults to false
settings.config (object | string)? custom config object(KubeConfig or object). String value will assume a config file location.
settings.config.url string? Openshift cluster url
settings.config.auth object? -
settings.config.auth.token string? auth token used to authenticate to the Openshift Cluster
settings.config.auth.username string? username to authenticate to Openshift
settings.config.auth.password string? password to authenticate to Openshift
settings.config.insecureSkipTlsVerify boolean? flag to ignore TLS verification
Returns
Promise: Returns the Rest Client