Skip to content

Commit

Permalink
Update Documentation reference to the same version of Kubernetes API …
Browse files Browse the repository at this point in the history
…1.29 (#3912)

Signed-off-by: varodrig <[email protected]>
  • Loading branch information
varodrig authored Oct 17, 2024
1 parent 3c7d3de commit 987c75e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
32 changes: 16 additions & 16 deletions content/en/docs/components/notebooks/api-reference/notebook-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Resource Types:
<td>
<code>metadata</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta">
Kubernetes meta/v1.ObjectMeta
</a>
</em>
Expand Down Expand Up @@ -118,7 +118,7 @@ string
<td>
<code>lastProbeTime</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#time-v1-meta">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#time-v1-meta">
Kubernetes meta/v1.Time
</a>
</em>
Expand Down Expand Up @@ -232,7 +232,7 @@ int32
<td>
<code>containerState</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#containerstate-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#containerstate-v1-core">
Kubernetes core/v1.ContainerState
</a>
</em>
Expand Down Expand Up @@ -263,7 +263,7 @@ Kubernetes core/v1.ContainerState
<td>
<code>spec</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podspec-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podspec-v1-core">
Kubernetes core/v1.PodSpec
</a>
</em>
Expand All @@ -276,7 +276,7 @@ Kubernetes core/v1.PodSpec
<td>
<code>volumes</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#volume-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#volume-v1-core">
[]Kubernetes core/v1.Volume
</a>
</em>
Expand All @@ -291,7 +291,7 @@ More info: <a href="https://kubernetes.io/docs/concepts/storage/volumes">https:/
<td>
<code>initContainers</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#container-v1-core">
[]Kubernetes core/v1.Container
</a>
</em>
Expand All @@ -316,7 +316,7 @@ More info: <a href="https://kubernetes.io/docs/concepts/workloads/pods/init-cont
<td>
<code>containers</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#container-v1-core">
[]Kubernetes core/v1.Container
</a>
</em>
Expand All @@ -332,7 +332,7 @@ Cannot be updated.</p>
<td>
<code>ephemeralContainers</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#ephemeralcontainer-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#ephemeralcontainer-v1-core">
[]Kubernetes core/v1.EphemeralContainer
</a>
</em>
Expand Down Expand Up @@ -536,7 +536,7 @@ Optional: Default to false.</p>
<td>
<code>securityContext</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podsecuritycontext-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podsecuritycontext-v1-core">
Kubernetes core/v1.PodSecurityContext
</a>
</em>
Expand All @@ -551,7 +551,7 @@ Optional: Defaults to empty. See type description for default values of each fi
<td>
<code>imagePullSecrets</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core">
[]Kubernetes core/v1.LocalObjectReference
</a>
</em>
Expand Down Expand Up @@ -594,7 +594,7 @@ If not specified, the pod will not have a domainname at all.</p>
<td>
<code>affinity</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#affinity-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#affinity-v1-core">
Kubernetes core/v1.Affinity
</a>
</em>
Expand All @@ -621,7 +621,7 @@ If not specified, the pod will be dispatched by default scheduler.</p>
<td>
<code>tolerations</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#toleration-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#toleration-v1-core">
[]Kubernetes core/v1.Toleration
</a>
</em>
Expand All @@ -635,7 +635,7 @@ If not specified, the pod will be dispatched by default scheduler.</p>
<td>
<code>hostAliases</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#hostalias-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#hostalias-v1-core">
[]Kubernetes core/v1.HostAlias
</a>
</em>
Expand Down Expand Up @@ -683,7 +683,7 @@ The higher the value, the higher the priority.</p>
<td>
<code>dnsConfig</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#poddnsconfig-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#poddnsconfig-v1-core">
Kubernetes core/v1.PodDNSConfig
</a>
</em>
Expand All @@ -699,7 +699,7 @@ configuration based on DNSPolicy.</p>
<td>
<code>readinessGates</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podreadinessgate-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podreadinessgate-v1-core">
[]Kubernetes core/v1.PodReadinessGate
</a>
</em>
Expand Down Expand Up @@ -781,7 +781,7 @@ This field is alpha-level as of Kubernetes v1.16, and is only honored by servers
<td>
<code>topologySpreadConstraints</code></br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#topologyspreadconstraint-v1-core">
<a href="https://v1-29.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#topologyspreadconstraint-v1-core">
[]Kubernetes core/v1.TopologySpreadConstraint
</a>
</em>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ This section describes the
* `container`:
Describes the Docker container that implements the component. A portable
subset of the Kubernetes
[Container v1 spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#container-v1-core).
[Container v1 spec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#container-v1-core).

* `image`: Name of the Docker image.
* `command`: Entrypoint array. The Docker image's
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Values specified using those two fields get converted to Spark configuration pro

## Specifying Environment Variables

There are two fields for specifying environment variables for the driver and/or executor containers, namely `.spec.driver.env` (or `.spec.executor.env` for the executor container) and `.spec.driver.envFrom` (or `.spec.executor.envFrom` for the executor container). Specifically, `.spec.driver.env` (and `.spec.executor.env`) takes a list of [EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#envvar-v1-core), each of which specifies an environment variable or the source of an environment variable, e.g., a name-value pair, a ConfigMap key, a Secret key, etc. Alternatively, `.spec.driver.envFrom` (and `.spec.executor.envFrom`) takes a list of [EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#envfromsource-v1-core) and allows [using all key-value pairs in a ConfigMap or Secret as environment variables](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#configure-all-key-value-pairs-in-a-configmap-as-container-environment-variables). The `SparkApplication` snippet below shows the use of both fields:
There are two fields for specifying environment variables for the driver and/or executor containers, namely `.spec.driver.env` (or `.spec.executor.env` for the executor container) and `.spec.driver.envFrom` (or `.spec.executor.envFrom` for the executor container). Specifically, `.spec.driver.env` (and `.spec.executor.env`) takes a list of [EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#envvar-v1-core), each of which specifies an environment variable or the source of an environment variable, e.g., a name-value pair, a ConfigMap key, a Secret key, etc. Alternatively, `.spec.driver.envFrom` (and `.spec.executor.envFrom`) takes a list of [EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#envfromsource-v1-core) and allows [using all key-value pairs in a ConfigMap or Secret as environment variables](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#configure-all-key-value-pairs-in-a-configmap-as-container-environment-variables). The `SparkApplication` snippet below shows the use of both fields:

```yaml
spec:
Expand Down Expand Up @@ -426,7 +426,7 @@ Note that the mutating admission webhook is needed to use this feature. Please r

## Using Sidecar Containers

A `SparkApplication` can specify one or more optional sidecar containers for the driver or executor pod, using the optional field `.spec.driver.sidecars` or `.spec.executor.sidecars`. The specification of each sidecar container follows the [Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#container-v1-core) API definition. Below is an example:
A `SparkApplication` can specify one or more optional sidecar containers for the driver or executor pod, using the optional field `.spec.driver.sidecars` or `.spec.executor.sidecars`. The specification of each sidecar container follows the [Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#container-v1-core) API definition. Below is an example:

```yaml
spec:
Expand All @@ -447,7 +447,7 @@ Note that the mutating admission webhook is needed to use this feature. Please r

## Using Init-Containers

A `SparkApplication` can optionally specify one or more [init-containers](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) for the driver or executor pod, using the optional field `.spec.driver.initContainers` or `.spec.executor.initContainers`, respectively. The specification of each init-container follows the [Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#container-v1-core) API definition. Below is an example:
A `SparkApplication` can optionally specify one or more [init-containers](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) for the driver or executor pod, using the optional field `.spec.driver.initContainers` or `.spec.executor.initContainers`, respectively. The specification of each init-container follows the [Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#container-v1-core) API definition. Below is an example:

```yaml
spec:
Expand Down

0 comments on commit 987c75e

Please sign in to comment.