Notebook CRD V1 Reference

Reference documentation for version v1 of the Notebook custom resource.

Packages:

kubeflow.org/v1

Package v1 contains API Schema definitions for the kubeflow.org v1 API group

Resource Types:

Notebook

Notebook is the Schema for the notebooks API

FieldDescription
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of themetadata field.
specNotebookSpec
templateNotebookTemplateSpecINSERT ADDITIONAL SPEC FIELDS - desired state of clusterImportant: Run “make” to regenerate code after modifying this file

statusNotebookStatus

NotebookCondition

(Appears on:NotebookStatus)

FieldDescription
typestringType is the type of the condition. Possible values are Running|Waiting|Terminated
lastProbeTimeKubernetes meta/v1.Time(Optional)Last time we probed the condition.
reasonstring(Optional)(brief) reason the container is in the current state
messagestring(Optional)Message regarding why the container is in the current state.

NotebookSpec

(Appears on:Notebook)

NotebookSpec defines the desired state of Notebook

FieldDescription
templateNotebookTemplateSpecINSERT ADDITIONAL SPEC FIELDS - desired state of clusterImportant: Run “make” to regenerate code after modifying this file

NotebookStatus

(Appears on:Notebook)

NotebookStatus defines the observed state of Notebook

FieldDescription
conditions[]NotebookConditionConditions is an array of current conditions
readyReplicasint32ReadyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
containerStateKubernetes core/v1.ContainerStateContainerState is the state of underlying container.

NotebookTemplateSpec

(Appears on:NotebookSpec)

FieldDescription
specKubernetes core/v1.PodSpec
volumes[]Kubernetes core/v1.Volume(Optional)List of volumes that can be mounted by containers belonging to the pod.More info: https://kubernetes.io/docs/concepts/storage/volumes
initContainers[]Kubernetes core/v1.ContainerList of initialization containers belonging to the pod.Init containers are executed in order prior to containers being started. If anyinit container fails, the pod is considered to have failed and is handled accordingto its restartPolicy. The name for an init container or normal container must beunique among all containers.Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.The resourceRequirements of an init container are taken into account during schedulingby finding the highest request/limit for each resource type, and then using the max ofof that value or the sum of the normal containers. Limits are applied to init containersin a similar fashion.Init containers cannot currently be added or removed.Cannot be updated.More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
containers[]Kubernetes core/v1.ContainerList of containers belonging to the pod.Containers cannot currently be added or removed.There must be at least one container in a Pod.Cannot be updated.
ephemeralContainers[]Kubernetes core/v1.EphemeralContainer(Optional)List of ephemeral containers run in this pod. Ephemeral containers may be run in an existingpod to perform user-initiated actions such as debugging. This list cannot be specified whencreating a pod, and it cannot be modified by updating the pod spec. In order to add anephemeral container to an existing pod, use the pod’s ephemeralcontainers subresource.This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.
restartPolicyKubernetes core/v1.RestartPolicy(Optional)Restart policy for all containers within the pod.One of Always, OnFailure, Never.Default to Always.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
terminationGracePeriodSecondsint64(Optional)Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.Value must be non-negative integer. The value zero indicates delete immediately.If this value is nil, the default grace period will be used instead.The grace period is the duration in seconds after the processes running in the pod are senta termination signal and the time when the processes are forcibly halted with a kill signal.Set this value longer than the expected cleanup time for your process.Defaults to 30 seconds.
activeDeadlineSecondsint64(Optional)Optional duration in seconds the pod may be active on the node relative toStartTime before the system will actively try to mark it failed and kill associated containers.Value must be a positive integer.
dnsPolicyKubernetes core/v1.DNSPolicy(Optional)Set DNS policy for the pod.Defaults to “ClusterFirst”.Valid values are ‘ClusterFirstWithHostNet’, ‘ClusterFirst’, ‘Default’ or ‘None’.DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.To have DNS options set along with hostNetwork, you have to specify DNS policyexplicitly to ‘ClusterFirstWithHostNet’.
nodeSelectormap[string]string(Optional)NodeSelector is a selector which must be true for the pod to fit on a node.Selector which must match a node’s labels for the pod to be scheduled on that node.More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
serviceAccountNamestring(Optional)ServiceAccountName is the name of the ServiceAccount to use to run this pod.More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
serviceAccountstring(Optional)DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.Deprecated: Use serviceAccountName instead.
automountServiceAccountTokenbool(Optional)AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
nodeNamestring(Optional)NodeName is a request to schedule this pod onto a specific node. If it is non-empty,the scheduler simply schedules this pod onto that node, assuming that it fits resourcerequirements.
hostNetworkbool(Optional)Host networking requested for this pod. Use the host’s network namespace.If this option is set, the ports that will be used must be specified.Default to false.
hostPIDbool(Optional)Use the host’s pid namespace.Optional: Default to false.
hostIPCbool(Optional)Use the host’s ipc namespace.Optional: Default to false.
shareProcessNamespacebool(Optional)Share a single process namespace between all of the containers in a pod.When this is set containers will be able to view and signal processes from other containersin the same pod, and the first process in each container will not be assigned PID 1.HostPID and ShareProcessNamespace cannot both be set.Optional: Default to false.
securityContextKubernetes core/v1.PodSecurityContext(Optional)SecurityContext holds pod-level security attributes and common container settings.Optional: Defaults to empty. See type description for default values of each field.
imagePullSecrets[]Kubernetes core/v1.LocalObjectReference(Optional)ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.If specified, these secrets will be passed to individual puller implementations for them to use. For example,in the case of docker, only DockerConfig type secrets are honored.More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
hostnamestring(Optional)Specifies the hostname of the PodIf not specified, the pod’s hostname will be set to a system-defined value.
subdomainstring(Optional)If specified, the fully qualified Pod hostname will be “...svc.”.If not specified, the pod will not have a domainname at all.
affinityKubernetes core/v1.Affinity(Optional)If specified, the pod’s scheduling constraints
schedulerNamestring(Optional)If specified, the pod will be dispatched by specified scheduler.If not specified, the pod will be dispatched by default scheduler.
tolerations[]Kubernetes core/v1.Toleration(Optional)If specified, the pod’s tolerations.
hostAliases[]Kubernetes core/v1.HostAlias(Optional)HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hostsfile if specified. This is only valid for non-hostNetwork pods.
priorityClassNamestring(Optional)If specified, indicates the pod’s priority. “system-node-critical” and“system-cluster-critical” are two special keywords which indicate thehighest priorities with the former being the highest priority. Any othername must be defined by creating a PriorityClass object with that name.If not specified, the pod priority will be default or zero if there is nodefault.
priorityint32(Optional)The priority value. Various system components use this field to find thepriority of the pod. When Priority Admission Controller is enabled, itprevents users from setting this field. The admission controller populatesthis field from PriorityClassName.The higher the value, the higher the priority.
dnsConfigKubernetes core/v1.PodDNSConfig(Optional)Specifies the DNS parameters of a pod.Parameters specified here will be merged to the generated DNSconfiguration based on DNSPolicy.
readinessGates[]Kubernetes core/v1.PodReadinessGate(Optional)If specified, all readiness gates will be evaluated for pod readiness.A pod is ready when all its containers are ready ANDall conditions specified in the readiness gates have status equal to “True”More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md
runtimeClassNamestring(Optional)RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be usedto run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.If unset or empty, the “legacy” RuntimeClass will be used, which is an implicit class with anempty definition that uses the default runtime handler.More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.mdThis is a beta feature as of Kubernetes v1.14.
enableServiceLinksbool(Optional)EnableServiceLinks indicates whether information about services should be injected into pod’senvironment variables, matching the syntax of Docker links.Optional: Defaults to true.
preemptionPolicyKubernetes core/v1.PreemptionPolicy(Optional)PreemptionPolicy is the Policy for preempting pods with lower priority.One of Never, PreemptLowerPriority.Defaults to PreemptLowerPriority if unset.This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature.
overheadKubernetes core/v1.ResourceList(Optional)Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.This field will be autopopulated at admission time by the RuntimeClass admission controller. Ifthe RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests.The RuntimeClass admission controller will reject Pod create requests which have the overhead alreadyset. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the valuedefined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero.More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.mdThis field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.
topologySpreadConstraints[]Kubernetes core/v1.TopologySpreadConstraint(Optional)TopologySpreadConstraints describes how a group of pods ought to spread across topologydomains. Scheduler will schedule pods in a way which abides by the constraints.This field is alpha-level and is only honored by clusters that enables the EvenPodsSpreadfeature.All topologySpreadConstraints are ANDed.


Generated with gen-crd-api-reference-docson git commit 3b35937.


Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified 12.02.2020: Add notebook CRD reference (#1673) (bb78d844)