Notebook (v1)

Notebook 资源的 v1 版本参考文档

kubeflow.org/v1

v1 包包含 kubeflow.org v1 API 组的 API Schema 定义

资源类型

    Notebook

    Notebook 是 notebooks API 的 Schema

    字段描述
    metadata
    Kubernetes meta/v1.ObjectMeta
    请参阅 Kubernetes API 文档了解 metadata 字段的详细信息。
    spec
    NotebookSpec


    template
    NotebookTemplateSpec

    插入附加的 SPEC 字段 - 集群的期望状态 重要:修改此文件后运行“make”以重新生成代码

    status
    NotebookStatus

    NotebookCondition

    (出现在: NotebookStatus 上)

    字段描述
    type
    string

    Type 是条件的类型。可能的值为 Running|Waiting|Terminated

    lastProbeTime
    Kubernetes meta/v1.Time
    (可选)

    上次探测条件的时间。

    reason
    string
    (可选)

    (简要) 容器处于当前状态的原因

    message
    string
    (可选)

    关于容器处于当前状态原因的消息。

    NotebookSpec

    (出现在: Notebook 上)

    NotebookSpec 定义 Notebook 的期望状态

    字段描述
    template
    NotebookTemplateSpec

    插入附加的 SPEC 字段 - 集群的期望状态 重要:修改此文件后运行“make”以重新生成代码

    NotebookStatus

    (出现在: Notebook 上)

    NotebookStatus 定义 Notebook 的观测状态

    字段描述
    conditions
    []NotebookCondition

    Conditions 是当前条件的数组

    readyReplicas
    int32

    ReadyReplicas 是 StatefulSet 控制器创建的、处于 Ready 状态的 Pod 数量。

    containerState
    Kubernetes core/v1.ContainerState

    ContainerState 是底层容器的状态。

    NotebookTemplateSpec

    (出现在: NotebookSpec 上)

    字段描述
    spec
    Kubernetes core/v1.PodSpec


    volumes
    []Kubernetes core/v1.Volume
    (可选)

    Pod 中容器可以挂载的卷列表。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes

    initContainers
    []Kubernetes core/v1.Container

    Pod 中的初始化容器列表。初始化容器在常规容器启动之前按顺序执行。如果任何初始化容器失败,则认为 Pod 失败,并根据其 restartPolicy 进行处理。初始化容器或常规容器的名称必须在所有容器中唯一。初始化容器不能包含 Lifecycle 操作、Readiness 探针、Liveness 探针或 Startup 探针。调度时会考虑初始化容器的 resourceRequirements,方法是找到每种资源类型的最高请求/限制,然后使用该值的最大值或常规容器的总和。限制也以类似的方式应用于初始化容器。当前不能添加或移除初始化容器。不能更新。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/init-containers/

    containers
    []Kubernetes core/v1.Container

    Pod 中的容器列表。当前不能添加或移除容器。Pod 中必须至少有一个容器。不能更新。

    ephemeralContainers
    []Kubernetes core/v1.EphemeralContainer
    (可选)

    在此 Pod 中运行的临时容器列表。可以在现有 Pod 中运行临时容器以执行用户发起的操作,例如调试。创建 Pod 时无法指定此列表,并且无法通过更新 Pod 规范进行修改。要向现有 Pod 添加临时容器,请使用 Pod 的 ephemeralcontainers 子资源。此字段为 Alpha 级别,仅受启用 EphemeralContainers 功能的服务器支持。

    restartPolicy
    string
    (可选)

    Pod 中所有容器的重启策略。可以是 Always、OnFailure、Never 中的一个。默认为 Always。更多信息:https://kubernetes.ac.cn/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

    terminationGracePeriodSeconds
    int64
    (可选)

    Pod 需要优雅终止的可选持续时间(秒)。可以在删除请求中减小。值必须是非负整数。值为零表示立即删除。如果此值为 nil,将使用默认的优雅终止周期。优雅终止周期是指 Pod 中运行的进程收到终止信号后,到进程被强制终止(kill 信号)之间的时间。应将此值设置得比进程预期的清理时间更长。默认为 30 秒。

    activeDeadlineSeconds
    int64
    (可选)

    Pod 在节点上相对于 StartTime 可活动的可选持续时间(秒),超过此时间后系统将主动尝试将其标记为失败并杀死关联的容器。值必须是正整数。

    dnsPolicy
    string
    (可选)

    设置 Pod 的 DNS 策略。默认为“ClusterFirst”。有效值为 ‘ClusterFirstWithHostNet’、‘ClusterFirst’、‘Default’ 或 ‘None’。DNSConfig 中给出的 DNS 参数将与 DNSPolicy 选择的策略合并。要在设置 hostNetwork 的同时设置 DNS 选项,必须明确将 DNS 策略指定为 ‘ClusterFirstWithHostNet’。

    nodeSelector
    map[string]string
    (可选)

    NodeSelector 是一个选择器,必须满足该选择器条件 Pod 才能适合某个节点。选择器必须与节点的标签匹配,Pod 才能调度到该节点上。更多信息:https://kubernetes.ac.cn/docs/concepts/configuration/assign-pod-node/

    serviceAccountName
    string
    (可选)

    ServiceAccountName 是用于运行此 Pod 的 ServiceAccount 的名称。更多信息:https://kubernetes.ac.cn/docs/tasks/configure-pod-container/configure-service-account/

    serviceAccount
    string
    (可选)

    DeprecatedServiceAccount 是 ServiceAccountName 的弃用别名。已弃用:请使用 serviceAccountName 代替。

    automountServiceAccountToken
    bool
    (可选)

    AutomountServiceAccountToken 指示是否应自动挂载服务账户令牌。

    nodeName
    string
    (可选)

    NodeName 是请求将此 Pod 调度到特定节点上。如果非空,调度器将直接将此 Pod 调度到该节点上,前提是它符合资源要求。

    hostNetwork
    bool
    (可选)

    为此 Pod 请求主机网络。使用主机的网络命名空间。如果设置此选项,则必须指定将使用的端口。默认为 false。

    hostPID
    bool
    (可选)

    使用主机的 pid 命名空间。可选:默认为 false。

    hostIPC
    bool
    (可选)

    使用主机的 ipc 命名空间。可选:默认为 false。

    shareProcessNamespace
    bool
    (可选)

    在 Pod 中的所有容器之间共享单个进程命名空间。设置此项后,容器将能够查看和发送信号给同一 Pod 中其他容器的进程,并且每个容器中的第一个进程将不会被分配 PID 1。HostPID 和 ShareProcessNamespace 不能同时设置。可选:默认为 false。

    securityContext
    Kubernetes core/v1.PodSecurityContext
    (可选)

    SecurityContext 包含 Pod 级别的安全属性和常见的容器设置。可选:默认为空。请参阅类型描述了解每个字段的默认值。

    imagePullSecrets
    []Kubernetes core/v1.LocalObjectReference
    (可选)

    ImagePullSecrets 是一个可选列表,引用同一命名空间中的 secrets,用于拉取此 PodSpec 使用的任何镜像。如果指定,这些 secrets 将传递给各个拉取实现供其使用。例如,对于 docker,仅 DockerConfig 类型的 secrets 受支持。更多信息:https://kubernetes.ac.cn/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

    hostname
    string
    (可选)

    指定 Pod 的主机名。如果未指定,Pod 的主机名将设置为系统定义的值。

    subdomain
    string
    (可选)

    如果指定,Pod 的完全限定主机名将是“...svc.”。如果未指定,则 Pod 完全没有域名。

    affinity
    Kubernetes core/v1.Affinity
    (可选)

    如果指定,Pod 的调度约束

    schedulerName
    string
    (可选)

    如果指定,Pod 将由指定的调度器调度。如果未指定,Pod 将由默认调度器调度。

    tolerations
    []Kubernetes core/v1.Toleration
    (可选)

    如果指定,Pod 的容忍度。

    hostAliases
    []Kubernetes core/v1.HostAlias
    (可选)

    HostAliases 是一个可选列表,包含如果指定将注入 Pod 的 hosts 文件中的主机和 IP。仅对非 hostNetwork 的 Pod 有效。

    priorityClassName
    string
    (可选)

    如果指定,表示 Pod 的优先级。“system-node-critical”和“system-cluster-critical”是两个特殊关键词,表示最高优先级,前者优先级最高。任何其他名称必须通过创建同名的 PriorityClass 对象来定义。如果未指定,Pod 优先级将为默认值或零(如果没有默认值)。

    priority
    int32
    (可选)

    优先级值。各种系统组件使用此字段来确定 Pod 的优先级。启用 Priority Admission Controller 后,它会阻止用户设置此字段。准入控制器会根据 PriorityClassName 填充此字段。值越高,优先级越高。

    dnsConfig
    Kubernetes core/v1.PodDNSConfig
    (可选)

    指定 Pod 的 DNS 参数。此处指定的参数将与基于 DNSPolicy 生成的 DNS 配置合并。

    readinessGates
    []Kubernetes core/v1.PodReadinessGate
    (可选)

    如果指定,将评估所有 readiness gates 以确定 Pod 是否就绪。当所有容器都就绪并且 readiness gates 中指定的所有条件的状态都等于“True”时,Pod 处于就绪状态。更多信息:https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md

    runtimeClassName
    string
    (可选)

    RuntimeClassName 指的是 node.k8s.io 组中的 RuntimeClass 对象,应用于运行此 Pod。如果没有 RuntimeClass 资源与指定的类名匹配,则不会运行该 Pod。如果未设置或为空,将使用“legacy”RuntimeClass,这是一个隐式类,定义为空,使用默认运行时处理器。更多信息:https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md 这是 Kubernetes v1.14 中的 Beta 功能。

    enableServiceLinks
    bool
    (可选)

    EnableServiceLinks 指示是否应将服务信息注入 Pod 的环境变量中,以匹配 Docker links 的语法。可选:默认为 true。

    preemptionPolicy
    string
    (可选)

    PreemptionPolicy 是抢占低优先级 Pod 的策略。可以是 Never、PreemptLowerPriority 中的一个。如果未设置,默认为 PreemptLowerPriority。此字段为 Alpha 级别,仅受启用 NonPreemptingPriority 功能的服务器支持。

    overhead
    object
    (可选)

    Overhead 表示运行给定 RuntimeClass 的 Pod 所关联的资源开销。此字段将在准入时由 RuntimeClass 准入控制器自动填充。如果 RuntimeClass 准入控制器已启用,创建 Pod 请求中不得设置 overhead。RuntimeClass 准入控制器将拒绝已设置 overhead 的 Pod 创建请求。如果在 PodSpec 中配置并选择了 RuntimeClass,Overhead 将设置为相应 RuntimeClass 中定义的值,否则将保持未设置并视为零。更多信息:https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md 此字段在 Kubernetes v1.16 中为 Alpha 级别,仅受启用 PodOverhead 功能的服务器支持。

    topologySpreadConstraints
    []Kubernetes core/v1.TopologySpreadConstraint
    (可选)

    TopologySpreadConstraints 描述了一组 Pod 应如何跨拓扑域分散。调度器将以符合约束的方式调度 Pod。此字段为 Alpha 级别,仅受启用 EvenPodsSpread 功能的集群支持。所有 topologySpreadConstraints 都将进行 AND 运算。


    使用 git commit 3b35937 生成的 gen-crd-api-reference-docs 工具生成。

    反馈

    此页面是否有帮助?