⎈ k8s knowledge compiler

Client Authentication (v1beta1) [page]deterministic

referencesecurity

## Resource Types

  • [ExecCredential](#client-authentication-k8s-io-v1beta1-ExecCredential)

## `ExecCredential` {#client-authentication-k8s-io-v1beta1-ExecCredential}

<p>ExecCredential is used by exec-based plugins to communicate credentials to HTTP transports.</p>

<table class="table"> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <tbody> <tr><td><code>apiVersion</code><br/>string</td><td><code>client.authentication.k8s.io/v1beta1</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>ExecCredential</code></td></tr> <tr><td><code>spec</code> <B>[Required]</B><br/> <a href="#client-authentication-k8s-io-v1beta1-ExecCredentialSpec"><code>ExecCredentialSpec</code></a> </td> <td> <p>Spec holds information passed to the plugin by the transport.</p> </td> </tr> <tr><td><code>status</code><br/> <a href="#client-authentication-k8s-io-v1beta1-ExecCredentialStatus"><code>ExecCredentialStatus</code></a> </td> <td> <p>Status is filled in by the plugin and holds the credentials that the transport should use to contact the API.</p> </td> </tr> </tbody> </table>

## `Cluster` {#client-authentication-k8s-io-v1beta1-Cluster}

Appears in:

  • [ExecCredentialSpec](#client-authentication-k8s-io-v1beta1-ExecCredentialSpec)

<p>Cluster contains information to allow an exec plugin to communicate with the kubernetes cluster being authenticated to.</p> <p>To ensure that this struct contains everything someone would need to communicate with a kubernetes cluster (just like they would via a kubeconfig), the fields should shadow &quot;k8s.io/client-go/tools/clientcmd/api/v1&quot;.Cluster, with the exception of CertificateAuthority, since CA data will always be passed to the plugin as bytes.</p>

<table class="table"> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <tbody> <tr><td><code>server</code> <B>[Required]</B><br/> <code>string</code> </td> <td> <p>Server is the address of the kubernetes cluster (https://hostname:port).</p> </td> </tr> <tr><td><code>tls-server-name</code><br/> <code>string</code> </td> <td> <p>TLSServerName is passed to the server for SNI and is used in the client to check server certificates against. If ServerName is empty, the hostname used to contact the server is used.</p> </td> </tr> <tr><td><code>insecure-skip-tls-verify</code><br/> <code>bool</code> </td> <td> <p>InsecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure.</p> </td> </tr> <tr><td><code>certificate-authority-data</code><br/> <code>[]byte</code> </td> <td> <p>CAData contains PEM-encoded certificate authority certificates. If empty, system roots should be used.</p> </td> </tr> <tr><td><code>proxy-url</code><br/> <code>string</code> </td> <td> <p>ProxyURL is the URL to the proxy to be used for all requests to this cluster.</p> </td> </tr> <tr><td><code>disable-compression</code><br/> <code>bool</code> </td> <td> <p>DisableCompression allows client to opt-out of response compression for all requests to the server. This is useful to speed up requests (specifically lists) when client-server network bandwidth is ample, by saving time on compression (server-side) and decompression (client-side): https://github.com/kubernetes/kubernetes/issues/112296.</p> </td> </tr> <tr><td><code>config</code><br/> <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension"><code>k8s.io/apimachinery/pkg/runtime.RawExtension</code></a> </td> <td> <p>Config holds additional config data that is specific to the exec plugin with regards to the cluster being authenticated to.</p> <p>This data is sourced from the clientcmd Cluster object's extensions[client.authentication.k8s.io/exec] field:</p> <p>clusters:</p> <ul> <li>name: my-cluster cluster: ... extensions: <ul> <li>name: client.authentication.k8s.io/exec # reserved extension name for per cluster exec config extensio …(trimmed)

Sources

reference/config-api/client-authentication.v1beta1.md · docClient Authentication (v1beta1)

Related (5)

part_of Resource typesdescribes conf=1

← all Docs