Parameter |
Choices/Defaults |
Comments |
api_key
|
|
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
|
api_version
|
Default:
v1
|
Use to specify the API version. in conjunction with kind, name, and namespace to identify a specific object.
aliases: api, version
|
cert_file
|
|
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
|
context
|
|
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
|
field_selectors
|
|
List of field selectors to use to filter results
|
host
|
|
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
key_file
|
|
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
kind
required |
|
Use to specify an object model. Use in conjunction with api_version, name, and namespace to identify a specific object.
|
kubeconfig
|
|
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
|
label_selectors
|
|
List of label selectors to use to filter results
|
name
|
|
Use to specify an object name. Use in conjunction with api_version, kind and namespace to identify a specific object.
|
namespace
|
|
Use to specify an object namespace. Use in conjunction with api_version, kind, and name to identify a specfic object.
|
password
|
|
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
|
ssl_ca_cert
|
|
Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
|
username
|
|
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
|
verify_ssl
bool |
|
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.
|