Question: What is See Also?

Answer: k u b e c t l   c r e a t e   s e c r e t   -   C r e a t e   a   s e c r e t   u s i n g   a   s p e c i f i e d   s u b c o m m a n d   T h i s   p a g e   i s   a u t o m a t i c a l l y   g e n e r a t e d .   I f   y o u   p l a n   t o   r e p o r t   a n   i s s u e   w i t h   t h i s   p a g e ,   m e n t i o n   t h a t   t h e   p a g e   i s   a u t o - g e n e r a t e d   i n   y o u r   i s s u e   d e s c r i p t i o n .   T h e   f i x   m a y   n e e d   t o   h a p p e n   e l s e w h e r e   i n   t h e   K u b e r n e t e s   p r o j e c t .


Question: What is Container Lifecycle Hooks?

Answer: Container Lifecycle HooksThis page describes how kubelet managed Containers can use the Container lifecycle hook framework to run code triggered by events during their management lifecycle.OverviewAnalogous to many programming language frameworks that have component lifecycle hooks, such as Angular, Kubernetes provides Containers with lifecycle hooks. The hooks enable Containers to be aware of events in their management lifecycle and run code implemented in a handler when the corresponding lifecycle hook is executed.Container hooksThere are two hooks that are exposed to Containers:PostStartThis hook is executed immediately after a container is created. However, there is no guarantee that the hook will execute before the container ENTRYPOINT. No parameters are passed to the handler.PreStopThis hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others. A call to the PreStop hook fails if the container is already in a terminated or completed state and the hook must complete before the TERM signal to stop the container can be sent. The Pod's termination grace period countdown begins before the PreStop hook is executed, so regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. No parameters are passed to the handler.A more detailed description of the termination behavior can be found in Termination of Pods.StopSignalThe StopSignal lifecycle can be used to define a stop signal which would be sent to the container when it is stopped. If you set this, it overrides any STOPSIGNAL instruction defined within the container image.A more detailed description of termination behaviour with custom stop signals can be found in Stop Signals.Hook handler implementationsContainers can access a hook by implementing and registering a handler for that hook. There are three types of hook handlers that can be implemented for Containers:Exec - Executes a specific command, such as pre-stop.sh, inside the cgroups and namespaces of the Container. Resources consumed by the command are counted against the Container.HTTP - Executes an HTTP request against a specific endpoint on the Container.Sleep - Pauses the container for a specified duration.Hook handler executionWhen a Container lifecycle management hook is called, the Kubernetes management system executes the handler according to the hook action, httpGet, tcpSocket (deprecated) and sleep are executed by the kubelet process, and exec is executed in the container.The PostStart hook handler call is initiated when a container is created, meaning the container ENTRYPOINT and the PostStart hook are triggered simultaneously. However, if the PostStart hook takes too long to execute or if it hangs, it can prevent the container from transitioning to a running state.PreStop hooks are not executed asynchronously from the signal to stop the


Question: How does Container Lifecycle Hooks work?

Answer: Container Lifecycle HooksThis page describes how kubelet managed Containers can use the Container lifecycle hook framework to run code triggered by events during their management lifecycle.OverviewAnalogous to many programming language frameworks that have component lifecycle hooks, such as Angular, Kubernetes provides Containers with lifecycle hooks. The hooks enable Containers to be aware of events in their management lifecycle and run code implemented in a handler when the corresponding lifecycle hook is executed.Container hooksThere are two hooks that are exposed to Containers:PostStartThis hook is executed immediately after a container is created. However, there is no guarantee that the hook will execute before the container ENTRYPOINT. No parameters are passed to the handler.PreStopThis hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others. A call to the PreStop hook fails if the container is already in a terminated or completed state and the hook must complete before the TERM signal to stop the container can be sent. The Pod's termination grace period countdown begins before the PreStop hook is executed, so regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. No parameters are passed to the handler.A more detailed description of the termination behavior can be found in Termination of Pods.StopSignalThe StopSignal lifecycle can be used to define a stop signal which would be sent to the container when it is stopped. If you set this, it overrides any STOPSIGNAL instruction defined within the container image.A more detailed description of termination behaviour with custom stop signals can be found in Stop Signals.Hook handler implementationsContainers can access a hook by implementing and registering a handler for that hook. There are three types of hook handlers that can be implemented for Containers:Exec - Executes a specific command, such as pre-stop.sh, inside the cgroups and namespaces of the Container. Resources consumed by the command are counted against the Container.HTTP - Executes an HTTP request against a specific endpoint on the Container.Sleep - Pauses the container for a specified duration.Hook handler executionWhen a Container lifecycle management hook is called, the Kubernetes management system executes the handler according to the hook action, httpGet, tcpSocket (deprecated) and sleep are executed by the kubelet process, and exec is executed in the container.The PostStart hook handler call is initiated when a container is created, meaning the container ENTRYPOINT and the PostStart hook are triggered simultaneously. However, if the PostStart hook takes too long to execute or if it hangs, it can prevent the container from transitioning to a running state.PreStop hooks are not executed asynchronously from the signal to stop the


Question: When would you use Container Lifecycle Hooks?

Answer: Container Lifecycle HooksThis page describes how kubelet managed Containers can use the Container lifecycle hook framework to run code triggered by events during their management lifecycle.OverviewAnalogous to many programming language frameworks that have component lifecycle hooks, such as Angular, Kubernetes provides Containers with lifecycle hooks. The hooks enable Containers to be aware of events in their management lifecycle and run code implemented in a handler when the corresponding lifecycle hook is executed.Container hooksThere are two hooks that are exposed to Containers:PostStartThis hook is executed immediately after a container is created. However, there is no guarantee that the hook will execute before the container ENTRYPOINT. No parameters are passed to the handler.PreStopThis hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others. A call to the PreStop hook fails if the container is already in a terminated or completed state and the hook must complete before the TERM signal to stop the container can be sent. The Pod's termination grace period countdown begins before the PreStop hook is executed, so regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. No parameters are passed to the handler.A more detailed description of the termination behavior can be found in Termination of Pods.StopSignalThe StopSignal lifecycle can be used to define a stop signal which would be sent to the container when it is stopped. If you set this, it overrides any STOPSIGNAL instruction defined within the container image.A more detailed description of termination behaviour with custom stop signals can be found in Stop Signals.Hook handler implementationsContainers can access a hook by implementing and registering a handler for that hook. There are three types of hook handlers that can be implemented for Containers:Exec - Executes a specific command, such as pre-stop.sh, inside the cgroups and namespaces of the Container. Resources consumed by the command are counted against the Container.HTTP - Executes an HTTP request against a specific endpoint on the Container.Sleep - Pauses the container for a specified duration.Hook handler executionWhen a Container lifecycle management hook is called, the Kubernetes management system executes the handler according to the hook action, httpGet, tcpSocket (deprecated) and sleep are executed by the kubelet process, and exec is executed in the container.The PostStart hook handler call is initiated when a container is created, meaning the container ENTRYPOINT and the PostStart hook are triggered simultaneously. However, if the PostStart hook takes too long to execute or if it hangs, it can prevent the container from transitioning to a running state.PreStop hooks are not executed asynchronously from the signal to stop the


Question: What are the benefits of Container Lifecycle Hooks?

Answer: Container Lifecycle HooksThis page describes how kubelet managed Containers can use the Container lifecycle hook framework to run code triggered by events during their management lifecycle.OverviewAnalogous to many programming language frameworks that have component lifecycle hooks, such as Angular, Kubernetes provides Containers with lifecycle hooks. The hooks enable Containers to be aware of events in their management lifecycle and run code implemented in a handler when the corresponding lifecycle hook is executed.Container hooksThere are two hooks that are exposed to Containers:PostStartThis hook is executed immediately after a container is created. However, there is no guarantee that the hook will execute before the container ENTRYPOINT. No parameters are passed to the handler.PreStopThis hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others. A call to the PreStop hook fails if the container is already in a terminated or completed state and the hook must complete before the TERM signal to stop the container can be sent. The Pod's termination grace period countdown begins before the PreStop hook is executed, so regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. No parameters are passed to the handler.A more detailed description of the termination behavior can be found in Termination of Pods.StopSignalThe StopSignal lifecycle can be used to define a stop signal which would be sent to the container when it is stopped. If you set this, it overrides any STOPSIGNAL instruction defined within the container image.A more detailed description of termination behaviour with custom stop signals can be found in Stop Signals.Hook handler implementationsContainers can access a hook by implementing and registering a handler for that hook. There are three types of hook handlers that can be implemented for Containers:Exec - Executes a specific command, such as pre-stop.sh, inside the cgroups and namespaces of the Container. Resources consumed by the command are counted against the Container.HTTP - Executes an HTTP request against a specific endpoint on the Container.Sleep - Pauses the container for a specified duration.Hook handler executionWhen a Container lifecycle management hook is called, the Kubernetes management system executes the handler according to the hook action, httpGet, tcpSocket (deprecated) and sleep are executed by the kubelet process, and exec is executed in the container.The PostStart hook handler call is initiated when a container is created, meaning the container ENTRYPOINT and the PostStart hook are triggered simultaneously. However, if the PostStart hook takes too long to execute or if it hangs, it can prevent the container from transitioning to a running state.PreStop hooks are not executed asynchronously from the signal to stop the


Question: What is Container Lifecycle Hooks?

Answer: T h i s   p a g e   d e s c r i b e s   h o w   k u b e l e t   m a n a g e d   C o n t a i n e r s   c a n   u s e   t h e   C o n t a i n e r   l i f e c y c l e   h o o k   f r a m e w o r k   t o   r u n   c o d e   t r i g g e r e d   b y   e v e n t s   d u r i n g   t h e i r   m a n a g e m e n t   l i f e c y c l e .


Question: What is Overview?

Answer: A n a l o g o u s   t o   m a n y   p r o g r a m m i n g   l a n g u a g e   f r a m e w o r k s   t h a t   h a v e   c o m p o n e n t   l i f e c y c l e   h o o k s ,   s u c h   a s   A n g u l a r ,   K u b e r n e t e s   p r o v i d e s   C o n t a i n e r s   w i t h   l i f e c y c l e   h o o k s .   T h e   h o o k s   e n a b l e   C o n t a i n e r s   t o   b e   a w a r e   o f   e v e n t s   i n   t h e i r   m a n a g e m e n t   l i f e c y c l e   a n d   r u n   c o d e   i m p l e m e n t e d   i n   a   h a n d l e r   w h e n   t h e   c o r r e s p o n d i n g   l i f e c y c l e   h o o k   i s   e x e c u t e d .


Question: What is Container hooks?

Answer: T h e r e   a r e   t w o   h o o k s   t h a t   a r e   e x p o s e d   t o   C o n t a i n e r s :   P o s t S t a r t   T h i s   h o o k   i s   e x e c u t e d   i m m e d i a t e l y   a f t e r   a   c o n t a i n e r   i s   c r e a t e d .   H o w e v e r ,   t h e r e   i s   n o   g u a r a n t e e   t h a t   t h e   h o o k   w i l l   e x e c u t e   b e f o r e   t h e   c o n t a i n e r   E N T R Y P O I N T .   N o   p a r a m e t e r s   a r e   p a s s e d   t o   t h e   h a n d l e r .   P r e S t o p   T h i s   h o o k   i s   c a l l e d   i m m e d i a t e l y   b e f o r e   a   c o n t a i n e r   i s   t e r m i n a t e d   d u e   t o   a n   A P I   r e q u e s t   o r   m a n a g e m e n t   e v e n t   s u c h   a s   a   l i v e n e s s / s t a r t u p   p r o b e   f a i l u r e ,   p r e e m p t i o n ,   r e s o u r c e   c o n t e n t i o n   a n d   o t h e r s .   A   c a l l   t o   t h e   P r e S t o p   h o o k   f a i l s   i f   t h e   c o n t a i n e r   i s   a l r e a d y   i n   a   t e r m i n a t e d   o r   c o m p l e t e d   s t a t e   a n d   t h e   h o o k   m u s t   c o m p l e t e   b e f o r e   t h e   T E R M   s i g n a l   t o   s t o p   t h e   c o n t a i n e r   c a n   b e   s e n t .   T h e   P o d ' s   t e r m i n a t i o n   g r a c e   p e r i o d   c o u n t d o w n   b e g i n s   b e f o r e   t h e   P r e S t o p   h o o k   i s   e x e c u t e d ,   s o   r e g a r d l e s s   o f   t h e   o u t c o m e   o f   t h e   h a n d l e r ,   t h e   c o n t a i n e r   w i l l   e v e n t u a l l y   t e r m i n a t e   w i t h i n   t h e   P o d ' s   t e r m i n a t i o n   g r a c e   p e r i o d .   N o   p a r a m e t e r s   a r e   p a s s e d   t o   t h e   h a n d l e r .   A   m o r e   d e t a i l e d   d e s c r i p t i o n   o f   t h e   t e r m i n a t i o n   b e h a v i o r   c a n   b e   f o u n d   i n   T e r m i n a t i o n   o f   P o d s .   S t o p S i g n a


Question: What is Hook handler implementations?

Answer: C o n t a i n e r s   c a n   a c c e s s   a   h o o k   b y   i m p l e m e n t i n g   a n d   r e g i s t e r i n g   a   h a n d l e r   f o r   t h a t   h o o k .   T h e r e   a r e   t h r e e   t y p e s   o f   h o o k   h a n d l e r s   t h a t   c a n   b e   i m p l e m e n t e d   f o r   C o n t a i n e r s :   E x e c   -   E x e c u t e s   a   s p e c i f i c   c o m m a n d ,   s u c h   a s   p r e - s t o p . s h ,   i n s i d e   t h e   c g r o u p s   a n d   n a m e s p a c e s   o f   t h e   C o n t a i n e r .   R e s o u r c e s   c o n s u m e d   b y   t h e   c o m m a n d   a r e   c o u n t e d   a g a i n s t   t h e   C o n t a i n e r . H T T P   -   E x e c u t e s   a n   H T T P   r e q u e s t   a g a i n s t   a   s p e c i f i c   e n d p o i n t   o n   t h e   C o n t a i n e r . S l e e p   -   P a u s e s   t h e   c o n t a i n e r   f o r   a   s p e c i f i e d   d u r a t i o n .


Question: What is Hook handler execution?

Answer: W h e n   a   C o n t a i n e r   l i f e c y c l e   m a n a g e m e n t   h o o k   i s   c a l l e d ,   t h e   K u b e r n e t e s   m a n a g e m e n t   s y s t e m   e x e c u t e s   t h e   h a n d l e r   a c c o r d i n g   t o   t h e   h o o k   a c t i o n ,   h t t p G e t ,   t c p S o c k e t   ( d e p r e c a t e d )   a n d   s l e e p   a r e   e x e c u t e d   b y   t h e   k u b e l e t   p r o c e s s ,   a n d   e x e c   i s   e x e c u t e d   i n   t h e   c o n t a i n e r .   T h e   P o s t S t a r t   h o o k   h a n d l e r   c a l l   i s   i n i t i a t e d   w h e n   a   c o n t a i n e r   i s   c r e a t e d ,   m e a n i n g   t h e   c o n t a i n e r   E N T R Y P O I N T   a n d   t h e   P o s t S t a r t   h o o k   a r e   t r i g g e r e d   s i m u l t a n e o u s l y .   H o w e v e r ,   i f   t h e   P o s t S t a r t   h o o k   t a k e s   t o o   l o n g   t o   e x e c u t e   o r   i f   i t   h a n g s ,   i t   c a n   p r e v e n t   t h e   c o n t a i n e r   f r o m   t r a n s i t i o n i n g   t o   a   r u n n i n g   s t a t e .   P r e S t o p   h o o k s   a r e   n o t   e x e c u t e d   a s y n c h r o n o u s l y   f r o m   t h e   s i g n a l   t o   s t o p   t h e   C o n t a i n e r ;   t h e   h o o k   m u s t   c o m p l e t e   i t s   e x e c u t i o n   b e f o r e   t h e   T E R M   s i g n a l   c a n   b e   s e n t .   I f   a   P r e S t o p   h o o k   h a n g s   d u r i n g   e x e c u t i o n ,   t h e   P o d ' s   p h a s e   w i l l   b e   T e r m i n a t i n g   a n d   r e m a i n   t h e r e   u n t i l   t h e   P o d   i s   k i l l e d   a f t e r   i t s   t e r m i n a t i o n G r a c e P e r i o d S e c o n d s   e x p i r e s .   T h i s   g r a c e   p e r i o d   a p p l i e s   t o   t h e   t o t a l   t i m e   i t   t a k e s   f o r   b o t h   t h e   P r e S t o p   h o o k   t o   e x e c u t e   a n d   f o r   t h e   C o n t a i n e r   t o   s t


Question: What is Hook delivery guarantees?

Answer: H o o k   d e l i v e r y   i s   i n t e n d e d   t o   b e   a t   l e a s t   o n c e ,   w h i c h   m e a n s   t h a t   a   h o o k   m a y   b e   c a l l e d   m u l t i p l e   t i m e s   f o r   a n y   g i v e n   e v e n t ,   s u c h   a s   f o r   P o s t S t a r t   o r   P r e S t o p .   I t   i s   u p   t o   t h e   h o o k   i m p l e m e n t a t i o n   t o   h a n d l e   t h i s   c o r r e c t l y .   G e n e r a l l y ,   o n l y   s i n g l e   d e l i v e r i e s   a r e   m a d e .   I f ,   f o r   e x a m p l e ,   a n   H T T P   h o o k   r e c e i v e r   i s   d o w n   a n d   i s   u n a b l e   t o   t a k e   t r a f f i c ,   t h e r e   i s   n o   a t t e m p t   t o   r e s e n d .   I n   s o m e   r a r e   c a s e s ,   h o w e v e r ,   d o u b l e   d e l i v e r y   m a y   o c c u r .   F o r   i n s t a n c e ,   i f   a   k u b e l e t   r e s t a r t s   i n   t h e   m i d d l e   o f   s e n d i n g   a   h o o k ,   t h e   h o o k   m i g h t   b e   r e s e n t   a f t e r   t h e   k u b e l e t   c o m e s   b a c k   u p .


Question: What is Debugging Hook handlers?

Answer: T h e   l o g s   f o r   a   H o o k   h a n d l e r   a r e   n o t   e x p o s e d   i n   P o d   e v e n t s .   I f   a   h a n d l e r   f a i l s   f o r   s o m e   r e a s o n ,   i t   b r o a d c a s t s   a n   e v e n t .   F o r   P o s t S t a r t ,   t h i s   i s   t h e   F a i l e d P o s t S t a r t H o o k   e v e n t ,   a n d   f o r   P r e S t o p ,   t h i s   i s   t h e   F a i l e d P r e S t o p H o o k   e v e n t .   T o   g e n e r a t e   a   f a i l e d   F a i l e d P o s t S t a r t H o o k   e v e n t   y o u r s e l f ,   m o d i f y   t h e   l i f e c y c l e - e v e n t s . y a m l   f i l e   t o   c h a n g e   t h e   p o s t S t a r t   c o m m a n d   t o   " b a d c o m m a n d "   a n d   a p p l y   i t .   H e r e   i s   s o m e   e x a m p l e   o u t p u t   o f   t h e   r e s u l t i n g   e v e n t s   y o u   s e e   f r o m   r u n n i n g   k u b e c t l   d e s c r i b e   p o d   l i f e c y c l e - d e m o :   E v e n t s :   T y p e   R e a s o n   A g e   F r o m   M e s s a g e   - - - -   - - - - - -   - - - -   - - - -   - - - - - - -   N o r m a l   S c h e d u l e d   7 s   d e f a u l t - s c h e d u l e r   S u c c e s s f u l l y   a s s i g n e d   d e f a u l t / l i f e c y c l e - d e m o   t o   i p - X X X - X X X - X X - X X . u s - e a s t - 2 . . .   N o r m a l   P u l l e d   6 s   k u b e l e t   S u c c e s s f u l l y   p u l l e d   i m a g e   " n g i n x "   i n   2 2 9 . 6 0 4 3 1 5 m s   N o r m a l   P u l l i n g   4 s   ( x 2   o v e r   6 s )   k u b e l e t   P u l l i n g   i m a g e   " n g i n x "   N o r m a l   C r e a t e d   4 s   ( x 2   o v e r   5 s )   k u b e l e t   C r e a t e d   c o n t a i n e r   l i f e c y c l e - d e m o - c o n t a i n e r   N o r m a l   S t a r t e d   4 s   ( x 2   o v e r   5 s )   k u b e l e t   S t a r t e d   c o n t a i n e r   l i f e c y c l e - d e m o - c o n t a i n e r   W a r n i n g   F a i l e d P o s t S t a r t


Question: What is What's next?

Answer: L e a r n   m o r e   a b o u t   t h e   C o n t a i n e r   e n v i r o n m e n t . G e t   h a n d s - o n   e x p e r i e n c e   a t t a c h i n g   h a n d l e r s   t o   C o n t a i n e r   l i f e c y c l e   e v e n t s .


Question: What is kubectl exec?

Answer: kubectl execSynopsisExecute a command in a container.kubectl exec (POD | TYPE/NAME) [-c CONTAINER] [flags] -- COMMAND [args...] Examples # Get output from running the 'date' command from pod mypod, using the first container by default kubectl exec mypod -- date # Get output from running the 'date' command in ruby-container from pod mypod kubectl exec mypod -c ruby-container -- date # Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod # and sends stdout/stderr from 'bash' back to the client kubectl exec mypod -c ruby-container -i -t -- bash -il # List contents of /usr from the first container of pod mypod and sort by modification time # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr") kubectl exec mypod -i -t -- ls -t /usr # Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default kubectl exec deploy/mydeployment -- date # Get output from running 'date' command from the first pod of the service myservice, using the first container by default kubectl exec svc/myservice -- date Options-c, --container stringContainer name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen-f, --filename stringsto use to exec into the resource-h, --helphelp for exec--pod-running-timeout duration Default: 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running-q, --quietOnly print output from the remote session-i, --stdinPass stdin to the container-t, --ttyStdin is a TTYParent Options Inherited--as stringUsername to impersonate for the operation. User could be a regular user or a service account in a namespace.--as-group stringsGroup to impersonate for the operation, this flag can be repeated to specify multiple groups.--as-uid stringUID to impersonate for the operation.--cache-dir string Default: "$HOME/.kube/cache"Default cache directory--certificate-authority stringPath to a cert file for the certificate authority--client-certificate stringPath to a client certificate file for TLS--client-key stringPath to a client key file for TLS--cluster stringThe name of the kubeconfig cluster to use--context stringThe name of the kubeconfig context to use--disable-compressionIf true, opt-out of response compression for all requests to the server--insecure-skip-tls-verifyIf true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure--kubeconfig stringPath to the kubeconfig file to use for CLI requests.--kuberc stringPath to the kuberc file to use for preferences. This can be disabled by exporting KUB


Question: How does kubectl exec work?

Answer: kubectl execSynopsisExecute a command in a container.kubectl exec (POD | TYPE/NAME) [-c CONTAINER] [flags] -- COMMAND [args...] Examples # Get output from running the 'date' command from pod mypod, using the first container by default kubectl exec mypod -- date # Get output from running the 'date' command in ruby-container from pod mypod kubectl exec mypod -c ruby-container -- date # Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod # and sends stdout/stderr from 'bash' back to the client kubectl exec mypod -c ruby-container -i -t -- bash -il # List contents of /usr from the first container of pod mypod and sort by modification time # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr") kubectl exec mypod -i -t -- ls -t /usr # Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default kubectl exec deploy/mydeployment -- date # Get output from running 'date' command from the first pod of the service myservice, using the first container by default kubectl exec svc/myservice -- date Options-c, --container stringContainer name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen-f, --filename stringsto use to exec into the resource-h, --helphelp for exec--pod-running-timeout duration Default: 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running-q, --quietOnly print output from the remote session-i, --stdinPass stdin to the container-t, --ttyStdin is a TTYParent Options Inherited--as stringUsername to impersonate for the operation. User could be a regular user or a service account in a namespace.--as-group stringsGroup to impersonate for the operation, this flag can be repeated to specify multiple groups.--as-uid stringUID to impersonate for the operation.--cache-dir string Default: "$HOME/.kube/cache"Default cache directory--certificate-authority stringPath to a cert file for the certificate authority--client-certificate stringPath to a client certificate file for TLS--client-key stringPath to a client key file for TLS--cluster stringThe name of the kubeconfig cluster to use--context stringThe name of the kubeconfig context to use--disable-compressionIf true, opt-out of response compression for all requests to the server--insecure-skip-tls-verifyIf true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure--kubeconfig stringPath to the kubeconfig file to use for CLI requests.--kuberc stringPath to the kuberc file to use for preferences. This can be disabled by exporting KUB


Question: When would you use kubectl exec?

Answer: kubectl execSynopsisExecute a command in a container.kubectl exec (POD | TYPE/NAME) [-c CONTAINER] [flags] -- COMMAND [args...] Examples # Get output from running the 'date' command from pod mypod, using the first container by default kubectl exec mypod -- date # Get output from running the 'date' command in ruby-container from pod mypod kubectl exec mypod -c ruby-container -- date # Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod # and sends stdout/stderr from 'bash' back to the client kubectl exec mypod -c ruby-container -i -t -- bash -il # List contents of /usr from the first container of pod mypod and sort by modification time # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr") kubectl exec mypod -i -t -- ls -t /usr # Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default kubectl exec deploy/mydeployment -- date # Get output from running 'date' command from the first pod of the service myservice, using the first container by default kubectl exec svc/myservice -- date Options-c, --container stringContainer name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen-f, --filename stringsto use to exec into the resource-h, --helphelp for exec--pod-running-timeout duration Default: 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running-q, --quietOnly print output from the remote session-i, --stdinPass stdin to the container-t, --ttyStdin is a TTYParent Options Inherited--as stringUsername to impersonate for the operation. User could be a regular user or a service account in a namespace.--as-group stringsGroup to impersonate for the operation, this flag can be repeated to specify multiple groups.--as-uid stringUID to impersonate for the operation.--cache-dir string Default: "$HOME/.kube/cache"Default cache directory--certificate-authority stringPath to a cert file for the certificate authority--client-certificate stringPath to a client certificate file for TLS--client-key stringPath to a client key file for TLS--cluster stringThe name of the kubeconfig cluster to use--context stringThe name of the kubeconfig context to use--disable-compressionIf true, opt-out of response compression for all requests to the server--insecure-skip-tls-verifyIf true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure--kubeconfig stringPath to the kubeconfig file to use for CLI requests.--kuberc stringPath to the kuberc file to use for preferences. This can be disabled by exporting KUB


Question: What are the benefits of kubectl exec?

Answer: kubectl execSynopsisExecute a command in a container.kubectl exec (POD | TYPE/NAME) [-c CONTAINER] [flags] -- COMMAND [args...] Examples # Get output from running the 'date' command from pod mypod, using the first container by default kubectl exec mypod -- date # Get output from running the 'date' command in ruby-container from pod mypod kubectl exec mypod -c ruby-container -- date # Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod # and sends stdout/stderr from 'bash' back to the client kubectl exec mypod -c ruby-container -i -t -- bash -il # List contents of /usr from the first container of pod mypod and sort by modification time # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr") kubectl exec mypod -i -t -- ls -t /usr # Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default kubectl exec deploy/mydeployment -- date # Get output from running 'date' command from the first pod of the service myservice, using the first container by default kubectl exec svc/myservice -- date Options-c, --container stringContainer name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen-f, --filename stringsto use to exec into the resource-h, --helphelp for exec--pod-running-timeout duration Default: 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running-q, --quietOnly print output from the remote session-i, --stdinPass stdin to the container-t, --ttyStdin is a TTYParent Options Inherited--as stringUsername to impersonate for the operation. User could be a regular user or a service account in a namespace.--as-group stringsGroup to impersonate for the operation, this flag can be repeated to specify multiple groups.--as-uid stringUID to impersonate for the operation.--cache-dir string Default: "$HOME/.kube/cache"Default cache directory--certificate-authority stringPath to a cert file for the certificate authority--client-certificate stringPath to a client certificate file for TLS--client-key stringPath to a client key file for TLS--cluster stringThe name of the kubeconfig cluster to use--context stringThe name of the kubeconfig context to use--disable-compressionIf true, opt-out of response compression for all requests to the server--insecure-skip-tls-verifyIf true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure--kubeconfig stringPath to the kubeconfig file to use for CLI requests.--kuberc stringPath to the kuberc file to use for preferences. This can be disabled by exporting KUB


Question: What is Synopsis?

Answer: E x e c u t e   a   c o m m a n d   i n   a   c o n t a i n e r .   k u b e c t l   e x e c   ( P O D   |   T Y P E / N A M E )   [ - c   C O N T A I N E R ]   [ f l a g s ]   - -   C O M M A N D   [ a r g s . . . ]


Question: What is Examples?

Answer: #   G e t   o u t p u t   f r o m   r u n n i n g   t h e   ' d a t e '   c o m m a n d   f r o m   p o d   m y p o d ,   u s i n g   t h e   f i r s t   c o n t a i n e r   b y   d e f a u l t   k u b e c t l   e x e c   m y p o d   - -   d a t e   #   G e t   o u t p u t   f r o m   r u n n i n g   t h e   ' d a t e '   c o m m a n d   i n   r u b y - c o n t a i n e r   f r o m   p o d   m y p o d   k u b e c t l   e x e c   m y p o d   - c   r u b y - c o n t a i n e r   - -   d a t e   #   S w i t c h   t o   r a w   t e r m i n a l   m o d e ;   s e n d s   s t d i n   t o   ' b a s h '   i n   r u b y - c o n t a i n e r   f r o m   p o d   m y p o d   #   a n d   s e n d s   s t d o u t / s t d e r r   f r o m   ' b a s h '   b a c k   t o   t h e   c l i e n t   k u b e c t l   e x e c   m y p o d   - c   r u b y - c o n t a i n e r   - i   - t   - -   b a s h   - i l   #   L i s t   c o n t e n t s   o f   / u s r   f r o m   t h e   f i r s t   c o n t a i n e r   o f   p o d   m y p o d   a n d   s o r t   b y   m o d i f i c a t i o n   t i m e   #   I f   t h e   c o m m a n d   y o u   w a n t   t o   e x e c u t e   i n   t h e   p o d   h a s   a n y   f l a g s   i n   c o m m o n   ( e . g .   - i ) ,   #   y o u   m u s t   u s e   t w o   d a s h e s   ( - - )   t o   s e p a r a t e   y o u r   c o m m a n d ' s   f l a g s / a r g u m e n t s   #   A l s o   n o t e ,   d o   n o t   s u r r o u n d   y o u r   c o m m a n d   a n d   i t s   f l a g s / a r g u m e n t s   w i t h   q u o t e s   #   u n l e s s   t h a t   i s   h o w   y o u   w o u l d   e x e c u t e   i t   n o r m a l l y   ( i . e . ,   d o   l s   - t   / u s r ,   n o t   " l s   - t   / u s r " )   k u b e c t l   e x e c   m y p o d   - i   - t   - -   l s   - t   / u s r   #   G e t   o u t p u t   f r o m   r u n n i n g   ' d a t e '   c o m m a n d   f r o m   t h e   f i r s t   p o d   o f   t h e   d e p l o y m e n t   m y d e p l o y m e n t ,   u s i n g


Question: What is Options?

Answer: C o n t a i n e r   n a m e .   I f   o m i t t e d ,   u s e   t h e   k u b e c t l . k u b e r n e t e s . i o / d e f a u l t - c o n t a i n e r   a n n o t a t i o n   f o r   s e l e c t i n g   t h e   c o n t a i n e r   t o   b e   a t t a c h e d   o r   t h e   f i r s t   c o n t a i n e r   i n   t h e   p o d   w i l l   b e   c h o s e n   t o   u s e   t o   e x e c   i n t o   t h e   r e s o u r c e   h e l p   f o r   e x e c   T h e   l e n g t h   o f   t i m e   ( l i k e   5 s ,   2 m ,   o r   3 h ,   h i g h e r   t h a n   z e r o )   t o   w a i t   u n t i l   a t   l e a s t   o n e   p o d   i s   r u n n i n g   O n l y   p r i n t   o u t p u t   f r o m   t h e   r e m o t e   s e s s i o n   P a s s   s t d i n   t o   t h e   c o n t a i n e r   S t d i n   i s   a   T T Y


Question: What is Parent Options Inherited?

Answer: U s e r n a m e   t o   i m p e r s o n a t e   f o r   t h e   o p e r a t i o n .   U s e r   c o u l d   b e   a   r e g u l a r   u s e r   o r   a   s e r v i c e   a c c o u n t   i n   a   n a m e s p a c e .   G r o u p   t o   i m p e r s o n a t e   f o r   t h e   o p e r a t i o n ,   t h i s   f l a g   c a n   b e   r e p e a t e d   t o   s p e c i f y   m u l t i p l e   g r o u p s .   U I D   t o   i m p e r s o n a t e   f o r   t h e   o p e r a t i o n .   D e f a u l t   c a c h e   d i r e c t o r y   P a t h   t o   a   c e r t   f i l e   f o r   t h e   c e r t i f i c a t e   a u t h o r i t y   P a t h   t o   a   c l i e n t   c e r t i f i c a t e   f i l e   f o r   T L S   P a t h   t o   a   c l i e n t   k e y   f i l e   f o r   T L S   T h e   n a m e   o f   t h e   k u b e c o n f i g   c l u s t e r   t o   u s e   T h e   n a m e   o f   t h e   k u b e c o n f i g   c o n t e x t   t o   u s e   I f   t r u e ,   o p t - o u t   o f   r e s p o n s e   c o m p r e s s i o n   f o r   a l l   r e q u e s t s   t o   t h e   s e r v e r   I f   t r u e ,   t h e   s e r v e r ' s   c e r t i f i c a t e   w i l l   n o t   b e   c h e c k e d   f o r   v a l i d i t y .   T h i s   w i l l   m a k e   y o u r   H T T P S   c o n n e c t i o n s   i n s e c u r e   P a t h   t o   t h e   k u b e c o n f i g   f i l e   t o   u s e   f o r   C L I   r e q u e s t s .   P a t h   t o   t h e   k u b e r c   f i l e   t o   u s e   f o r   p r e f e r e n c e s .   T h i s   c a n   b e   d i s a b l e d   b y   e x p o r t i n g   K U B E C T L _ K U B E R C = f a l s e   f e a t u r e   g a t e   o r   t u r n i n g   o f f   t h e   f e a t u r e   K U B E R C = o f f .   R e q u i r e   s e r v e r   v e r s i o n   t o   m a t c h   c l i e n t   v e r s i o n   I f   p r e s e n t ,   t h e   n a m e s p a c e   s c o p e   f o r   t h i s   C L I   r e q u e s t   P a s s w o r d   f o r   b a s i c   a u t h e n t i c a t


Question: What is See Also?

Answer: k u b e c t l   -   k u b e c t l   c o n t r o l s   t h e   K u b e r n e t e s   c l u s t e r   m a n a g e r   T h i s   p a g e   i s   a u t o m a t i c a l l y   g e n e r a t e d .   I f   y o u   p l a n   t o   r e p o r t   a n   i s s u e   w i t h   t h i s   p a g e ,   m e n t i o n   t h a t   t h e   p a g e   i s   a u t o - g e n e r a t e d   i n   y o u r   i s s u e   d e s c r i p t i o n .   T h e   f i x   m a y   n e e d   t o   h a p p e n   e l s e w h e r e   i n   t h e   K u b e r n e t e s   p r o j e c t .


Question: What is Blog guidelines?

Answer: Blog guidelinesThese guidelines cover the main Kubernetes blog and the Kubernetes contributor blog.All blog content must also adhere to the overall policy in the content guide.Before you beginMake sure you are familiar with the introduction sections of contributing to Kubernetes blogs, not just to learn about the two official blogs and the differences between them, but also to get an overview of the process.Original contentThe Kubernetes project accepts original content only, in English.Note:The Kubernetes project cannot accept content for the blog if it has already been submitted or published outside of the Kubernetes project.The official blogs are not available as a medium to repurpose existing content from any third party as new content.This restriction even carries across to promoting other Linux Foundation and CNCF projects. Many CNCF projects have their own blog. These are often a better choice for posts about a specific project, even if that other project is designed specifically to work with Kubernetes (or with Linux, etc).Relevant contentArticles must contain content that applies broadly to the Kubernetes community. For example, a submission should focus on upstream Kubernetes as opposed to vendor-specific configurations. For articles submitted to the main blog that are not mirror articles, hyperlinks in the article should commonly be to the official Kubernetes documentation. When making external references, links should be diverse - for example, a submission shouldn't contain only links back to a single company's blog.The official Kubernetes blogs are not the place for vendor pitches or for articles that promote a specific solution from outside Kubernetes.Sometimes this is a delicate balance. You can ask in Slack (#sig-docs-blog) for guidance on whether a post is appropriate for the Kubernetes blog and / or contributor blog - don't hesitate to reach out.The content guide applies unconditionally to blog articles and the PRs that add them. Bear in mind that some restrictions in the guide state that they are only relevant to documentation; those marked restrictions don't apply to blog articles.LocalizationThe website is localized into many languages; English is the “upstream” for all the other localizations. Even if you speak another language and would be happy to provide a localization, that should be in a separate pull request (see languages per PR).Copyright and reuseYou must write original content and you must have permission to license that content to the Cloud Native Computing Foundation (so that the Kubernetes project can legally publish it). This means that not only is direct plagiarism forbidden, you cannot write a blog article if you don't have permission to meet the CNCF copyright license conditions (for example, if your employer has a policy about intellectual property that restricts what you are allowed to do).The license for the blog allows commercial use of the content for commercial purposes, but not the other way around.Sp


Question: How does Blog guidelines work?

Answer: Blog guidelinesThese guidelines cover the main Kubernetes blog and the Kubernetes contributor blog.All blog content must also adhere to the overall policy in the content guide.Before you beginMake sure you are familiar with the introduction sections of contributing to Kubernetes blogs, not just to learn about the two official blogs and the differences between them, but also to get an overview of the process.Original contentThe Kubernetes project accepts original content only, in English.Note:The Kubernetes project cannot accept content for the blog if it has already been submitted or published outside of the Kubernetes project.The official blogs are not available as a medium to repurpose existing content from any third party as new content.This restriction even carries across to promoting other Linux Foundation and CNCF projects. Many CNCF projects have their own blog. These are often a better choice for posts about a specific project, even if that other project is designed specifically to work with Kubernetes (or with Linux, etc).Relevant contentArticles must contain content that applies broadly to the Kubernetes community. For example, a submission should focus on upstream Kubernetes as opposed to vendor-specific configurations. For articles submitted to the main blog that are not mirror articles, hyperlinks in the article should commonly be to the official Kubernetes documentation. When making external references, links should be diverse - for example, a submission shouldn't contain only links back to a single company's blog.The official Kubernetes blogs are not the place for vendor pitches or for articles that promote a specific solution from outside Kubernetes.Sometimes this is a delicate balance. You can ask in Slack (#sig-docs-blog) for guidance on whether a post is appropriate for the Kubernetes blog and / or contributor blog - don't hesitate to reach out.The content guide applies unconditionally to blog articles and the PRs that add them. Bear in mind that some restrictions in the guide state that they are only relevant to documentation; those marked restrictions don't apply to blog articles.LocalizationThe website is localized into many languages; English is the “upstream” for all the other localizations. Even if you speak another language and would be happy to provide a localization, that should be in a separate pull request (see languages per PR).Copyright and reuseYou must write original content and you must have permission to license that content to the Cloud Native Computing Foundation (so that the Kubernetes project can legally publish it). This means that not only is direct plagiarism forbidden, you cannot write a blog article if you don't have permission to meet the CNCF copyright license conditions (for example, if your employer has a policy about intellectual property that restricts what you are allowed to do).The license for the blog allows commercial use of the content for commercial purposes, but not the other way around.Sp


Question: When would you use Blog guidelines?

Answer: Blog guidelinesThese guidelines cover the main Kubernetes blog and the Kubernetes contributor blog.All blog content must also adhere to the overall policy in the content guide.Before you beginMake sure you are familiar with the introduction sections of contributing to Kubernetes blogs, not just to learn about the two official blogs and the differences between them, but also to get an overview of the process.Original contentThe Kubernetes project accepts original content only, in English.Note:The Kubernetes project cannot accept content for the blog if it has already been submitted or published outside of the Kubernetes project.The official blogs are not available as a medium to repurpose existing content from any third party as new content.This restriction even carries across to promoting other Linux Foundation and CNCF projects. Many CNCF projects have their own blog. These are often a better choice for posts about a specific project, even if that other project is designed specifically to work with Kubernetes (or with Linux, etc).Relevant contentArticles must contain content that applies broadly to the Kubernetes community. For example, a submission should focus on upstream Kubernetes as opposed to vendor-specific configurations. For articles submitted to the main blog that are not mirror articles, hyperlinks in the article should commonly be to the official Kubernetes documentation. When making external references, links should be diverse - for example, a submission shouldn't contain only links back to a single company's blog.The official Kubernetes blogs are not the place for vendor pitches or for articles that promote a specific solution from outside Kubernetes.Sometimes this is a delicate balance. You can ask in Slack (#sig-docs-blog) for guidance on whether a post is appropriate for the Kubernetes blog and / or contributor blog - don't hesitate to reach out.The content guide applies unconditionally to blog articles and the PRs that add them. Bear in mind that some restrictions in the guide state that they are only relevant to documentation; those marked restrictions don't apply to blog articles.LocalizationThe website is localized into many languages; English is the “upstream” for all the other localizations. Even if you speak another language and would be happy to provide a localization, that should be in a separate pull request (see languages per PR).Copyright and reuseYou must write original content and you must have permission to license that content to the Cloud Native Computing Foundation (so that the Kubernetes project can legally publish it). This means that not only is direct plagiarism forbidden, you cannot write a blog article if you don't have permission to meet the CNCF copyright license conditions (for example, if your employer has a policy about intellectual property that restricts what you are allowed to do).The license for the blog allows commercial use of the content for commercial purposes, but not the other way around.Sp


Question: What are the benefits of Blog guidelines?

Answer: Blog guidelinesThese guidelines cover the main Kubernetes blog and the Kubernetes contributor blog.All blog content must also adhere to the overall policy in the content guide.Before you beginMake sure you are familiar with the introduction sections of contributing to Kubernetes blogs, not just to learn about the two official blogs and the differences between them, but also to get an overview of the process.Original contentThe Kubernetes project accepts original content only, in English.Note:The Kubernetes project cannot accept content for the blog if it has already been submitted or published outside of the Kubernetes project.The official blogs are not available as a medium to repurpose existing content from any third party as new content.This restriction even carries across to promoting other Linux Foundation and CNCF projects. Many CNCF projects have their own blog. These are often a better choice for posts about a specific project, even if that other project is designed specifically to work with Kubernetes (or with Linux, etc).Relevant contentArticles must contain content that applies broadly to the Kubernetes community. For example, a submission should focus on upstream Kubernetes as opposed to vendor-specific configurations. For articles submitted to the main blog that are not mirror articles, hyperlinks in the article should commonly be to the official Kubernetes documentation. When making external references, links should be diverse - for example, a submission shouldn't contain only links back to a single company's blog.The official Kubernetes blogs are not the place for vendor pitches or for articles that promote a specific solution from outside Kubernetes.Sometimes this is a delicate balance. You can ask in Slack (#sig-docs-blog) for guidance on whether a post is appropriate for the Kubernetes blog and / or contributor blog - don't hesitate to reach out.The content guide applies unconditionally to blog articles and the PRs that add them. Bear in mind that some restrictions in the guide state that they are only relevant to documentation; those marked restrictions don't apply to blog articles.LocalizationThe website is localized into many languages; English is the “upstream” for all the other localizations. Even if you speak another language and would be happy to provide a localization, that should be in a separate pull request (see languages per PR).Copyright and reuseYou must write original content and you must have permission to license that content to the Cloud Native Computing Foundation (so that the Kubernetes project can legally publish it). This means that not only is direct plagiarism forbidden, you cannot write a blog article if you don't have permission to meet the CNCF copyright license conditions (for example, if your employer has a policy about intellectual property that restricts what you are allowed to do).The license for the blog allows commercial use of the content for commercial purposes, but not the other way around.Sp


Question: What is Blog guidelines?

Answer: T h e s e   g u i d e l i n e s   c o v e r   t h e   m a i n   K u b e r n e t e s   b l o g   a n d   t h e   K u b e r n e t e s   c o n t r i b u t o r   b l o g .   A l l   b l o g   c o n t e n t   m u s t   a l s o   a d h e r e   t o   t h e   o v e r a l l   p o l i c y   i n   t h e   c o n t e n t   g u i d e .


Question: What is Before you begin?

Answer: M a k e   s u r e   y o u   a r e   f a m i l i a r   w i t h   t h e   i n t r o d u c t i o n   s e c t i o n s   o f   c o n t r i b u t i n g   t o   K u b e r n e t e s   b l o g s ,   n o t   j u s t   t o   l e a r n   a b o u t   t h e   t w o   o f f i c i a l   b l o g s   a n d   t h e   d i f f e r e n c e s   b e t w e e n   t h e m ,   b u t   a l s o   t o   g e t   a n   o v e r v i e w   o f   t h e   p r o c e s s .


Question: What is Original content?

Answer: T h e   K u b e r n e t e s   p r o j e c t   a c c e p t s   o r i g i n a l   c o n t e n t   o n l y ,   i n   E n g l i s h .


Question: What is Note:?

Answer: T h e   K u b e r n e t e s   p r o j e c t   c a n n o t   a c c e p t   c o n t e n t   f o r   t h e   b l o g   i f   i t   h a s   a l r e a d y   b e e n   s u b m i t t e d   o r   p u b l i s h e d   o u t s i d e   o f   t h e   K u b e r n e t e s   p r o j e c t .   T h e   o f f i c i a l   b l o g s   a r e   n o t   a v a i l a b l e   a s   a   m e d i u m   t o   r e p u r p o s e   e x i s t i n g   c o n t e n t   f r o m   a n y   t h i r d   p a r t y   a s   n e w   c o n t e n t .   T h i s   r e s t r i c t i o n   e v e n   c a r r i e s   a c r o s s   t o   p r o m o t i n g   o t h e r   L i n u x   F o u n d a t i o n   a n d   C N C F   p r o j e c t s .   M a n y   C N C F   p r o j e c t s   h a v e   t h e i r   o w n   b l o g .   T h e s e   a r e   o f t e n   a   b e t t e r   c h o i c e   f o r   p o s t s   a b o u t   a   s p e c i f i c   p r o j e c t ,   e v e n   i f   t h a t   o t h e r   p r o j e c t   i s   d e s i g n e d   s p e c i f i c a l l y   t o   w o r k   w i t h   K u b e r n e t e s   ( o r   w i t h   L i n u x ,   e t c ) .


Question: What is Relevant content?

Answer: A r t i c l e s   m u s t   c o n t a i n   c o n t e n t   t h a t   a p p l i e s   b r o a d l y   t o   t h e   K u b e r n e t e s   c o m m u n i t y .   F o r   e x a m p l e ,   a   s u b m i s s i o n   s h o u l d   f o c u s   o n   u p s t r e a m   K u b e r n e t e s   a s   o p p o s e d   t o   v e n d o r - s p e c i f i c   c o n f i g u r a t i o n s .   F o r   a r t i c l e s   s u b m i t t e d   t o   t h e   m a i n   b l o g   t h a t   a r e   n o t   m i r r o r   a r t i c l e s ,   h y p e r l i n k s   i n   t h e   a r t i c l e   s h o u l d   c o m m o n l y   b e   t o   t h e   o f f i c i a l   K u b e r n e t e s   d o c u m e n t a t i o n .   W h e n   m a k i n g   e x t e r n a l   r e f e r e n c e s ,   l i n k s   s h o u l d   b e   d i v e r s e   -   f o r   e x a m p l e ,   a   s u b m i s s i o n   s h o u l d n ' t   c o n t a i n   o n l y   l i n k s   b a c k   t o   a   s i n g l e   c o m p a n y ' s   b l o g .   T h e   o f f i c i a l   K u b e r n e t e s   b l o g s   a r e   n o t   t h e   p l a c e   f o r   v e n d o r   p i t c h e s   o r   f o r   a r t i c l e s   t h a t   p r o m o t e   a   s p e c i f i c   s o l u t i o n   f r o m   o u t s i d e   K u b e r n e t e s .   S o m e t i m e s   t h i s   i s   a   d e l i c a t e   b a l a n c e .   Y o u   c a n   a s k   i n   S l a c k   ( # s i g - d o c s - b l o g )   f o r   g u i d a n c e   o n   w h e t h e r   a   p o s t   i s   a p p r o p r i a t e   f o r   t h e   K u b e r n e t e s   b l o g   a n d   /   o r   c o n t r i b u t o r   b l o g   -   d o n ' t   h e s i t a t e   t o   r e a c h   o u t .   T h e   c o n t e n t   g u i d e   a p p l i e s   u n c o n d i t i o n a l l y   t o   b l o g   a r t i c l e s   a n d   t h e   P R s   t h a t   a d d   t h e m .   B e a r   i n   m i n d   t h a t   s o m e   r e s t r i c t i o n s   i n   t h e   g u i d e   s t a t e   t h a t   t h e y   a r e   o n l y   r e l e


Question: What is Localization?

Answer: T h e   w e b s i t e   i s   l o c a l i z e d   i n t o   m a n y   l a n g u a g e s ;   E n g l i s h   i s   t h e   “ u p s t r e a m ”   f o r   a l l   t h e   o t h e r   l o c a l i z a t i o n s .   E v e n   i f   y o u   s p e a k   a n o t h e r   l a n g u a g e   a n d   w o u l d   b e   h a p p y   t o   p r o v i d e   a   l o c a l i z a t i o n ,   t h a t   s h o u l d   b e   i n   a   s e p a r a t e   p u l l   r e q u e s t   ( s e e   l a n g u a g e s   p e r   P R ) .


Question: What is Copyright and reuse?

Answer: Y o u   m u s t   w r i t e   o r i g i n a l   c o n t e n t   a n d   y o u   m u s t   h a v e   p e r m i s s i o n   t o   l i c e n s e   t h a t   c o n t e n t   t o   t h e   C l o u d   N a t i v e   C o m p u t i n g   F o u n d a t i o n   ( s o   t h a t   t h e   K u b e r n e t e s   p r o j e c t   c a n   l e g a l l y   p u b l i s h   i t ) .   T h i s   m e a n s   t h a t   n o t   o n l y   i s   d i r e c t   p l a g i a r i s m   f o r b i d d e n ,   y o u   c a n n o t   w r i t e   a   b l o g   a r t i c l e   i f   y o u   d o n ' t   h a v e   p e r m i s s i o n   t o   m e e t   t h e   C N C F   c o p y r i g h t   l i c e n s e   c o n d i t i o n s   ( f o r   e x a m p l e ,   i f   y o u r   e m p l o y e r   h a s   a   p o l i c y   a b o u t   i n t e l l e c t u a l   p r o p e r t y   t h a t   r e s t r i c t s   w h a t   y o u   a r e   a l l o w e d   t o   d o ) .   T h e   l i c e n s e   f o r   t h e   b l o g   a l l o w s   c o m m e r c i a l   u s e   o f   t h e   c o n t e n t   f o r   c o m m e r c i a l   p u r p o s e s ,   b u t   n o t   t h e   o t h e r   w a y   a r o u n d .


Question: What is Special interest groups and working groups?

Answer: T o p i c s   r e l a t e d   t o   p a r t i c i p a t i o n   i n   o r   r e s u l t s   o f   K u b e r n e t e s   S I G   a c t i v i t i e s   a r e   a l w a y s   o n   t o p i c   ( s e e   t h e   w o r k   i n   t h e   C o n t r i b u t o r   C o m m s   T e a m   f o r   s u p p o r t   o n   t h e s e   p o s t s ) .   T h e   p r o j e c t   t y p i c a l l y   m i r r o r s   t h e s e   a r t i c l e s   t o   b o t h   b l o g s .


Question: What is National restrictions on content?

Answer: T h e   K u b e r n e t e s   w e b s i t e   h a s   a n   I n t e r n e t   C o n t e n t   P r o v i d e r   ( I C P )   l i c e n c e   f r o m   t h e   g o v e r n m e n t   o f   C h i n a .   A l t h o u g h   i t ' s   u n l i k e l y   t o   b e   a   p r o b l e m ,   K u b e r n e t e s   c a n n o t   p u b l i s h   a r t i c l e s   t h a t   w o u l d   b e   b l o c k e d   b y   t h e   C h i n e s e   g o v e r n m e n t ' s   o f f i c i a l   f i l t e r i n g   o f   i n t e r n e t   c o n t e n t .


Question: What is Blog-specific content guidance?

Answer: A s   w e l l   a s   t h e   g e n e r a l   s t y l e   g u i d e ,   b l o g   a r t i c l e s   s h o u l d   ( n o t   m u s t )   a l i g n   t o   t h e   b l o g - s p e c i f i c   s t y l e   r e c o m m e n d a t i o n s .   T h e   r e m a i n d e r   o f   t h i s   p a g e   i s   a d d i t i o n a l   g u i d a n c e ;   t h e s e   a r e   n o t   s t r i c t   r u l e s   t h a t   a r t i c l e s   m u s t   f o l l o w ,   b u t   r e v i e w e r s   a r e   l i k e l y   t o   ( a n d   s h o u l d )   a s k   f o r   e d i t s   t o   a r t i c l e s   t h a t   a r e   o b v i o u s l y   n o t   a l i g n e d   w i t h   t h e   r e c o m m e n d a t i o n s   h e r e .


Question: What is Diagrams and illustrations?

Answer: F o r   i l l u s t r a t i o n s   -   i n c l u d i n g   d i a g r a m s   o r   c h a r t s   -   u s e   t h e   f i g u r e   s h o r t c o d e   w h e r e   f e a s i b l e .   Y o u   s h o u l d   s e t   a n   a l t   a t t r i b u t e   f o r   a c c e s s i b i l i t y .   U s e   v e c t o r   i m a g e s   f o r   i l l u s t r a t i o n s ,   t e c h n i c a l   d i a g r a m s   a n d   s i m i l a r   g r a p h i c s ;   S V G   f o r m a t   i s   r e c o m m e n d e d   a s   a   s t r o n g   p r e f e r e n c e .   A r t i c l e s   t h a t   u s e   r a s t e r   i m a g e s   f o r   i l l u s t r a t i o n s   a r e   m o r e   d i f f i c u l t   t o   m a i n t a i n   a n d   i n   s o m e   c a s e s   t h e   b l o g   t e a m   m a y   a s k   a u t h o r s   t o   r e v i s e   t h e   a r t i c l e   b e f o r e   i t   c o u l d   b e   p u b l i s h e d .


Question: What is Timelessness?

Answer: B l o g   p o s t s   s h o u l d   a i m   t o   b e   f u t u r e   p r o o f   G i v e n   t h e   d e v e l o p m e n t   v e l o c i t y   o f   t h e   p r o j e c t ,   S I G   D o c s   p r e f e r s   t i m e l e s s   w r i t i n g :   c o n t e n t   t h a t   w o n ' t   r e q u i r e   u p d a t e s   t o   s t a y   a c c u r a t e   f o r   t h e   r e a d e r . I t   c a n   b e   a   b e t t e r   c h o i c e   t o   a d d   a   t u t o r i a l   o r   u p d a t e   o f f i c i a l   d o c u m e n t a t i o n   t h a n   t o   w r i t e   a   h i g h   l e v e l   o v e r v i e w   a s   a   b l o g   p o s t . C o n s i d e r   c o n c e n t r a t i n g   t h e   l o n g   t e c h n i c a l   c o n t e n t   a s   a   c a l l   t o   a c t i o n   o f   t h e   b l o g   p o s t ,   a n d   f o c u s   o n   t h e   p r o b l e m   s p a c e   o r   w h y   r e a d e r s   s h o u l d   c a r e .


Question: What is Content examples?

Answer: H e r e   a r e   s o m e   e x a m p l e s   o f   c o n t e n t   t h a t   i s   a p p r o p r i a t e   f o r   t h e   m a i n   K u b e r n e t e s   b l o g :   A n n o u n c e m e n t s   a b o u t   n e w   K u b e r n e t e s   c a p a b i l i t i e s E x p l a n a t i o n s   o f   h o w   t o   a c h i e v e   a n   o u t c o m e   u s i n g   K u b e r n e t e s ;   f o r   e x a m p l e ,   t e l l   u s   a b o u t   y o u r   l o w - t o i l   i m p r o v e m e n t   o n   t h e   b a s i c   i d e a   o f   a   r o l l i n g   d e p l o y C o m p a r i s o n s   o f   s e v e r a l   d i f f e r e n t   s o f t w a r e   o p t i o n s   t h a t   h a v e   a   l i n k   t o   K u b e r n e t e s   a n d   c l o u d   n a t i v e .   I t ' s   O K   t o   h a v e   a   l i n k   t o   o n e   o f   t h e s e   o p t i o n s   s o   l o n g   a s   y o u   f u l l y   d i s c l o s e   y o u r   c o n f l i c t   o f   i n t e r e s t   /   r e l a t i o n s h i p . S t o r i e s   a b o u t   p r o b l e m s   o r   i n c i d e n t s ,   a n d   h o w   y o u   r e s o l v e d   t h e m A r t i c l e s   d i s c u s s i n g   b u i l d i n g   a   c l o u d   n a t i v e   p l a t f o r m   f o r   s p e c i f i c   u s e   c a s e s Y o u r   o p i n i o n   a b o u t   t h e   g o o d   o r   b a d   p o i n t s   a b o u t   K u b e r n e t e s A n n o u n c e m e n t s   a n d   s t o r i e s   a b o u t   n o n - c o r e   K u b e r n e t e s ,   s u c h   a s   t h e   G a t e w a y   A P I P o s t - r e l e a s e   a n n o u n c e m e n t s   a n d   u p d a t e s M e s s a g e s   a b o u t   i m p o r t a n t   K u b e r n e t e s   s e c u r i t y   v u l n e r a b i l i t i e s K u b e r n e t e s   p r o j e c t s   u p d a t e s T u t o r i a l s   a n d   w a l k t h r o u g h s T h o u g h t   l e a d e r s h i p   a r o u n d   K u b e r n e t e s   a n d   c l o u d   n a t i v e T h e   c o m p o n e n t s   o f   K u b e r n e t e


Question: What is Examples of content that wouldn't be accepted?

Answer: H o w e v e r ,   t h e   p r o j e c t   w i l l   n o t   p u b l i s h :   v e n d o r   p i t c h e s a n   a r t i c l e   y o u ' v e   p u b l i s h e d   e l s e w h e r e ,   e v e n   i f   o n l y   t o   y o u r   o w n   l o w - t r a f f i c   b l o g l a r g e   c h u n k s   o f   e x a m p l e   s o u r c e   c o d e   w i t h   o n l y   a   m i n i m a l   e x p l a n a t i o n u p d a t e s   a b o u t   a n   e x t e r n a l   p r o j e c t   t h a t   w o r k s   w i t h   o u r   r e l i e s   o n   K u b e r n e t e s   ( p u t   t h o s e   o n   t h e   e x t e r n a l   p r o j e c t ' s   o w n   b l o g ) a r t i c l e s   a b o u t   u s i n g   K u b e r n e t e s   w i t h   a   s p e c i f i c   c l o u d   p r o v i d e r a r t i c l e s   t h a t   c r i t i c i s e   s p e c i f i c   p e o p l e ,   g r o u p s   o f   p e o p l e ,   o r   b u s i n e s s e s a r t i c l e s   t h a t   h a v e   i m p o r t a n t   t e c h n i c a l   m i s t a k e s   o r   m i s l e a d i n g   d e t a i l s   ( f o r   e x a m p l e :   i f   y o u   r e c o m m e n d   t u r n i n g   o f f   a n   i m p o r t a n t   s e c u r i t y   c o n t r o l   i n   p r o d u c t i o n   c l u s t e r s ,   b e c a u s e   i t   c a n   b e   i n c o n v e n i e n t ,   t h e   K u b e r n e t e s   p r o j e c t   i s   l i k e l y   t o   r e j e c t   t h e   a r t i c l e ) .


Question: What is Docs smoke test page?

Answer: Shutdown of interactive tutorialsThe interactive tutorials previously on this website have been shut down.Kubernetes is grateful to O'Reilly and Katacoda for many years of helping people take their first steps in learning Kubernetes.The shutdown followed O'Reilly Media's 2019 acquisition of Katacoda.The tutorials ceased to function after the 31st of March, 2023. You are seeing this notice because this particular page has not yet been updated following that shutdown.Docs smoke test pageThis page serves two purposes:Demonstrate how the Kubernetes documentation uses MarkdownProvide a "smoke test" document we can use to test HTML, CSS, and template changes that affect the overall documentation.Heading levelsThe above heading is an H2. The page title renders as an H1. The following sections show H3 - H6.### H3 This is in an H3 section. #### H4 This is in an H4 section. ##### H5 This is in an H5 section. ###### H6 This is in an H6 section. Produces:H3This is in an H3 section.H4This is in an H4 section.H5This is in an H5 section.H6This is in an H6 section.Inline elementsInline elements show up within the text of paragraph, list item, admonition, or other block-level element.Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Inline text stylesYou can use different text styles in markdown like:- **bold** - _italic_ - ***bold italic*** - ~~strikethrough~~ - underline - _underline italic_ - **underline bold** - ***underline bold italic*** - `monospace text` - **`monospace bold`** Produces:bolditalicbold italicstrikethroughunderlineunderline italicunderline boldunderline bold italicmonospace textmonospace boldListsMarkdown doesn't have strict rules about how to process lists. When we moved from Jekyll to Hugo, we broke some lists. To fix them, keep the following in mind:Make sure you indent sub-list items 2 spaces.To end a list and start another, you need an HTML comment block on a new line between the lists, flush with the left-hand border. The first list won't end otherwise, no matter how many blank lines you put between it and the second.Bullet listsYou can add a bullet list in markdown like:- This is a list item. * This is another list item in the same list. - You can mix `-` and `*`. - To make a sub-item, indent two spaces. - This is a sub-sub-item. Indent two more spaces. - Another sub-item. Produces:This is a list item.This is another list item in the same list.You can mix - and *.To make a sub-item, indent two spaces.This is a sub-sub-item. Indent two more spaces.Another sub-item.Also,This is a new list. With Hugo, you need to use a HT


Question: How does Docs smoke test page work?

Answer: Shutdown of interactive tutorialsThe interactive tutorials previously on this website have been shut down.Kubernetes is grateful to O'Reilly and Katacoda for many years of helping people take their first steps in learning Kubernetes.The shutdown followed O'Reilly Media's 2019 acquisition of Katacoda.The tutorials ceased to function after the 31st of March, 2023. You are seeing this notice because this particular page has not yet been updated following that shutdown.Docs smoke test pageThis page serves two purposes:Demonstrate how the Kubernetes documentation uses MarkdownProvide a "smoke test" document we can use to test HTML, CSS, and template changes that affect the overall documentation.Heading levelsThe above heading is an H2. The page title renders as an H1. The following sections show H3 - H6.### H3 This is in an H3 section. #### H4 This is in an H4 section. ##### H5 This is in an H5 section. ###### H6 This is in an H6 section. Produces:H3This is in an H3 section.H4This is in an H4 section.H5This is in an H5 section.H6This is in an H6 section.Inline elementsInline elements show up within the text of paragraph, list item, admonition, or other block-level element.Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Inline text stylesYou can use different text styles in markdown like:- **bold** - _italic_ - ***bold italic*** - ~~strikethrough~~ - underline - _underline italic_ - **underline bold** - ***underline bold italic*** - `monospace text` - **`monospace bold`** Produces:bolditalicbold italicstrikethroughunderlineunderline italicunderline boldunderline bold italicmonospace textmonospace boldListsMarkdown doesn't have strict rules about how to process lists. When we moved from Jekyll to Hugo, we broke some lists. To fix them, keep the following in mind:Make sure you indent sub-list items 2 spaces.To end a list and start another, you need an HTML comment block on a new line between the lists, flush with the left-hand border. The first list won't end otherwise, no matter how many blank lines you put between it and the second.Bullet listsYou can add a bullet list in markdown like:- This is a list item. * This is another list item in the same list. - You can mix `-` and `*`. - To make a sub-item, indent two spaces. - This is a sub-sub-item. Indent two more spaces. - Another sub-item. Produces:This is a list item.This is another list item in the same list.You can mix - and *.To make a sub-item, indent two spaces.This is a sub-sub-item. Indent two more spaces.Another sub-item.Also,This is a new list. With Hugo, you need to use a HT


Question: When would you use Docs smoke test page?

Answer: Shutdown of interactive tutorialsThe interactive tutorials previously on this website have been shut down.Kubernetes is grateful to O'Reilly and Katacoda for many years of helping people take their first steps in learning Kubernetes.The shutdown followed O'Reilly Media's 2019 acquisition of Katacoda.The tutorials ceased to function after the 31st of March, 2023. You are seeing this notice because this particular page has not yet been updated following that shutdown.Docs smoke test pageThis page serves two purposes:Demonstrate how the Kubernetes documentation uses MarkdownProvide a "smoke test" document we can use to test HTML, CSS, and template changes that affect the overall documentation.Heading levelsThe above heading is an H2. The page title renders as an H1. The following sections show H3 - H6.### H3 This is in an H3 section. #### H4 This is in an H4 section. ##### H5 This is in an H5 section. ###### H6 This is in an H6 section. Produces:H3This is in an H3 section.H4This is in an H4 section.H5This is in an H5 section.H6This is in an H6 section.Inline elementsInline elements show up within the text of paragraph, list item, admonition, or other block-level element.Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Inline text stylesYou can use different text styles in markdown like:- **bold** - _italic_ - ***bold italic*** - ~~strikethrough~~ - underline - _underline italic_ - **underline bold** - ***underline bold italic*** - `monospace text` - **`monospace bold`** Produces:bolditalicbold italicstrikethroughunderlineunderline italicunderline boldunderline bold italicmonospace textmonospace boldListsMarkdown doesn't have strict rules about how to process lists. When we moved from Jekyll to Hugo, we broke some lists. To fix them, keep the following in mind:Make sure you indent sub-list items 2 spaces.To end a list and start another, you need an HTML comment block on a new line between the lists, flush with the left-hand border. The first list won't end otherwise, no matter how many blank lines you put between it and the second.Bullet listsYou can add a bullet list in markdown like:- This is a list item. * This is another list item in the same list. - You can mix `-` and `*`. - To make a sub-item, indent two spaces. - This is a sub-sub-item. Indent two more spaces. - Another sub-item. Produces:This is a list item.This is another list item in the same list.You can mix - and *.To make a sub-item, indent two spaces.This is a sub-sub-item. Indent two more spaces.Another sub-item.Also,This is a new list. With Hugo, you need to use a HT


Question: What are the benefits of Docs smoke test page?

Answer: Shutdown of interactive tutorialsThe interactive tutorials previously on this website have been shut down.Kubernetes is grateful to O'Reilly and Katacoda for many years of helping people take their first steps in learning Kubernetes.The shutdown followed O'Reilly Media's 2019 acquisition of Katacoda.The tutorials ceased to function after the 31st of March, 2023. You are seeing this notice because this particular page has not yet been updated following that shutdown.Docs smoke test pageThis page serves two purposes:Demonstrate how the Kubernetes documentation uses MarkdownProvide a "smoke test" document we can use to test HTML, CSS, and template changes that affect the overall documentation.Heading levelsThe above heading is an H2. The page title renders as an H1. The following sections show H3 - H6.### H3 This is in an H3 section. #### H4 This is in an H4 section. ##### H5 This is in an H5 section. ###### H6 This is in an H6 section. Produces:H3This is in an H3 section.H4This is in an H4 section.H5This is in an H5 section.H6This is in an H6 section.Inline elementsInline elements show up within the text of paragraph, list item, admonition, or other block-level element.Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Inline text stylesYou can use different text styles in markdown like:- **bold** - _italic_ - ***bold italic*** - ~~strikethrough~~ - underline - _underline italic_ - **underline bold** - ***underline bold italic*** - `monospace text` - **`monospace bold`** Produces:bolditalicbold italicstrikethroughunderlineunderline italicunderline boldunderline bold italicmonospace textmonospace boldListsMarkdown doesn't have strict rules about how to process lists. When we moved from Jekyll to Hugo, we broke some lists. To fix them, keep the following in mind:Make sure you indent sub-list items 2 spaces.To end a list and start another, you need an HTML comment block on a new line between the lists, flush with the left-hand border. The first list won't end otherwise, no matter how many blank lines you put between it and the second.Bullet listsYou can add a bullet list in markdown like:- This is a list item. * This is another list item in the same list. - You can mix `-` and `*`. - To make a sub-item, indent two spaces. - This is a sub-sub-item. Indent two more spaces. - Another sub-item. Produces:This is a list item.This is another list item in the same list.You can mix - and *.To make a sub-item, indent two spaces.This is a sub-sub-item. Indent two more spaces.Another sub-item.Also,This is a new list. With Hugo, you need to use a HT


Question: What is Shutdown of interactive tutorials?

Answer: T h e   i n t e r a c t i v e   t u t o r i a l s   p r e v i o u s l y   o n   t h i s   w e b s i t e   h a v e   b e e n   s h u t   d o w n .   K u b e r n e t e s   i s   g r a t e f u l   t o   O ' R e i l l y   a n d   K a t a c o d a   f o r   m a n y   y e a r s   o f   h e l p i n g   p e o p l e   t a k e   t h e i r   f i r s t   s t e p s   i n   l e a r n i n g   K u b e r n e t e s .   T h e   s h u t d o w n   f o l l o w e d   O ' R e i l l y   M e d i a ' s   2 0 1 9   a c q u i s i t i o n   o f   K a t a c o d a .   T h e   t u t o r i a l s   c e a s e d   t o   f u n c t i o n   a f t e r   t h e   3 1 s t   o f   M a r c h ,   2 0 2 3 .   Y o u   a r e   s e e i n g   t h i s   n o t i c e   b e c a u s e   t h i s   p a r t i c u l a r   p a g e   h a s   n o t   y e t   b e e n   u p d a t e d   f o l l o w i n g   t h a t   s h u t d o w n .


Question: What is Docs smoke test page?

Answer: T h i s   p a g e   s e r v e s   t w o   p u r p o s e s :   D e m o n s t r a t e   h o w   t h e   K u b e r n e t e s   d o c u m e n t a t i o n   u s e s   M a r k d o w n P r o v i d e   a   " s m o k e   t e s t "   d o c u m e n t   w e   c a n   u s e   t o   t e s t   H T M L ,   C S S ,   a n d   t e m p l a t e   c h a n g e s   t h a t   a f f e c t   t h e   o v e r a l l   d o c u m e n t a t i o n .


Question: What is Heading levels?

Answer: T h e   a b o v e   h e a d i n g   i s   a n   H 2 .   T h e   p a g e   t i t l e   r e n d e r s   a s   a n   H 1 .   T h e   f o l l o w i n g   s e c t i o n s   s h o w   H 3   -   H 6 .   # # #   H 3   T h i s   i s   i n   a n   H 3   s e c t i o n .   # # # #   H 4   T h i s   i s   i n   a n   H 4   s e c t i o n .   # # # # #   H 5   T h i s   i s   i n   a n   H 5   s e c t i o n .   # # # # # #   H 6   T h i s   i s   i n   a n   H 6   s e c t i o n .   P r o d u c e s :


Question: What is H3?

Answer: T h i s   i s   i n   a n   H 3   s e c t i o n .


Question: What is H4?

Answer: T h i s   i s   i n   a n   H 4   s e c t i o n .


Question: What is H5?

Answer: T h i s   i s   i n   a n   H 5   s e c t i o n .


Question: What is H6?

Answer: T h i s   i s   i n   a n   H 6   s e c t i o n .


Question: What is Inline elements?

Answer: I n l i n e   e l e m e n t s   s h o w   u p   w i t h i n   t h e   t e x t   o f   p a r a g r a p h ,   l i s t   i t e m ,   a d m o n i t i o n ,   o r   o t h e r   b l o c k - l e v e l   e l e m e n t .   L o r e m   i p s u m   d o l o r   s i t   a m e t ,   c o n s e c t e t u r   a d i p i s i c i n g   e l i t ,   s e d   d o   e i u s m o d   t e m p o r   i n c i d i d u n t   u t   l a b o r e   e t   d o l o r e   m a g n a   a l i q u a .   U t   e n i m   a d   m i n i m   v e n i a m ,   q u i s   n o s t r u d   e x e r c i t a t i o n   u l l a m c o   l a b o r i s   n i s i   u t   a l i q u i p   e x   e a   c o m m o d o   c o n s e q u a t .   D u i s   a u t e   i r u r e   d o l o r   i n   r e p r e h e n d e r i t   i n   v o l u p t a t e   v e l i t   e s s e   c i l l u m   d o l o r e   e u   f u g i a t   n u l l a   p a r i a t u r .   E x c e p t e u r   s i n t   o c c a e c a t   c u p i d a t a t   n o n   p r o i d e n t ,   s u n t   i n   c u l p a   q u i   o f f i c i a   d e s e r u n t   m o l l i t   a n i m   i d   e s t   l a b o r u m .


Question: What is Inline text styles?

Answer: Y o u   c a n   u s e   d i f f e r e n t   t e x t   s t y l e s   i n   m a r k d o w n   l i k e :   -   * * b o l d * *   -   _ i t a l i c _   -   * * * b o l d   i t a l i c * * *   -   ~ ~ s t r i k e t h r o u g h ~ ~   -   < u > u n d e r l i n e < / u >   -   _ < u > u n d e r l i n e   i t a l i c < / u > _   -   * * < u > u n d e r l i n e   b o l d < / u > * *   -   * * * < u > u n d e r l i n e   b o l d   i t a l i c < / u > * * *   -   ` m o n o s p a c e   t e x t `   -   * * ` m o n o s p a c e   b o l d ` * *   P r o d u c e s :   b o l d i t a l i c b o l d   i t a l i c s t r i k e t h r o u g h u n d e r l i n e u n d e r l i n e   i t a l i c u n d e r l i n e   b o l d u n d e r l i n e   b o l d   i t a l i c m o n o s p a c e   t e x t m o n o s p a c e   b o l d


Question: What is Lists?

Answer: M a r k d o w n   d o e s n ' t   h a v e   s t r i c t   r u l e s   a b o u t   h o w   t o   p r o c e s s   l i s t s .   W h e n   w e   m o v e d   f r o m   J e k y l l   t o   H u g o ,   w e   b r o k e   s o m e   l i s t s .   T o   f i x   t h e m ,   k e e p   t h e   f o l l o w i n g   i n   m i n d :   M a k e   s u r e   y o u   i n d e n t   s u b - l i s t   i t e m s   2   s p a c e s . T o   e n d   a   l i s t   a n d   s t a r t   a n o t h e r ,   y o u   n e e d   a n   H T M L   c o m m e n t   b l o c k   o n   a   n e w   l i n e   b e t w e e n   t h e   l i s t s ,   f l u s h   w i t h   t h e   l e f t - h a n d   b o r d e r .   T h e   f i r s t   l i s t   w o n ' t   e n d   o t h e r w i s e ,   n o   m a t t e r   h o w   m a n y   b l a n k   l i n e s   y o u   p u t   b e t w e e n   i t   a n d   t h e   s e c o n d .   M a k e   s u r e   y o u   i n d e n t   s u b - l i s t   i t e m s   2   s p a c e s .   T o   e n d   a   l i s t   a n d   s t a r t   a n o t h e r ,   y o u   n e e d   a n   H T M L   c o m m e n t   b l o c k   o n   a   n e w   l i n e   b e t w e e n   t h e   l i s t s ,   f l u s h   w i t h   t h e   l e f t - h a n d   b o r d e r .   T h e   f i r s t   l i s t   w o n ' t   e n d   o t h e r w i s e ,   n o   m a t t e r   h o w   m a n y   b l a n k   l i n e s   y o u   p u t   b e t w e e n   i t   a n d   t h e   s e c o n d .


Question: What is Bullet lists?

Answer: Y o u   c a n   a d d   a   b u l l e t   l i s t   i n   m a r k d o w n   l i k e :   -   T h i s   i s   a   l i s t   i t e m .   *   T h i s   i s   a n o t h e r   l i s t   i t e m   i n   t h e   s a m e   l i s t .   -   Y o u   c a n   m i x   ` - `   a n d   ` * ` .   -   T o   m a k e   a   s u b - i t e m ,   i n d e n t   t w o   s p a c e s .   -   T h i s   i s   a   s u b - s u b - i t e m .   I n d e n t   t w o   m o r e   s p a c e s .   -   A n o t h e r   s u b - i t e m .   P r o d u c e s :   T h i s   i s   a   l i s t   i t e m .   T h i s   i s   a n o t h e r   l i s t   i t e m   i n   t h e   s a m e   l i s t .   Y o u   c a n   m i x   -   a n d   * . T o   m a k e   a   s u b - i t e m ,   i n d e n t   t w o   s p a c e s . T h i s   i s   a   s u b - s u b - i t e m .   I n d e n t   t w o   m o r e   s p a c e s . A n o t h e r   s u b - i t e m .   T o   m a k e   a   s u b - i t e m ,   i n d e n t   t w o   s p a c e s . T h i s   i s   a   s u b - s u b - i t e m .   I n d e n t   t w o   m o r e   s p a c e s . A n o t h e r   s u b - i t e m .   T h i s   i s   a   s u b - s u b - i t e m .   I n d e n t   t w o   m o r e   s p a c e s .   A l s o ,   T h i s   i s   a   n e w   l i s t .   W i t h   H u g o ,   y o u   n e e d   t o   u s e   a   H T M L   c o m m e n t   t o   s e p a r a t e   t w o   c o n s e c u t i v e   l i s t s .   T h e   H T M L   c o m m e n t   n e e d s   t o   b e   a t   t h e   l e f t   m a r g i n . B u l l e t   l i s t s   c a n   h a v e   p a r a g r a p h s   o r   b l o c k   e l e m e n t s   w i t h i n   t h e m . I n d e n t   t h e   c o n t e n t   t o   b e   t h e   s a m e   a s   t h e   f i r s t   l i n e   o f   t h e   b u l l e t   p o i n t .   T h i s   p a r a g r a p h   a n d   t h e   c o d e   b l o c k   l i n e   u p   w i t h   t h e   f i r s t   B   i n   B u l l e t   a b o v e . l s   - l   A n d   a   s u b - l i s t   a f t e r   s o m e   b l o c k -


Question: What is Numbered lists?

Answer: T h i s   i s   a   l i s t   i t e m . T h i s   i s   a n o t h e r   l i s t   i t e m   i n   t h e   s a m e   l i s t .   T h e   n u m b e r   y o u   u s e   i n   M a r k d o w n   d o e s   n o t   n e c e s s a r i l y   c o r r e l a t e   t o   t h e   n u m b e r   i n   t h e   f i n a l   o u t p u t .   B y   c o n v e n t i o n ,   w e   k e e p   t h e m   i n   s y n c .


Question: What is Note:?

Answer: T h i s   i s   a   n e w   l i s t .   W i t h   H u g o ,   y o u   n e e d   t o   u s e   a n   H T M L   c o m m e n t   t o   s e p a r a t e   t w o   c o n s e c u t i v e   l i s t s .   T h e   H T M L   c o m m e n t   n e e d s   t o   b e   a t   t h e   l e f t   m a r g i n . N u m b e r e d   l i s t s   c a n   h a v e   p a r a g r a p h s   o r   b l o c k   e l e m e n t s   w i t h i n   t h e m . I n d e n t   t h e   c o n t e n t   t o   b e   t h e   s a m e   a s   t h e   f i r s t   l i n e   o f   t h e   b u l l e t   p o i n t .   T h i s   p a r a g r a p h   a n d   t h e   c o d e   b l o c k   l i n e   u p   w i t h   t h e   N   i n   N u m b e r e d   a b o v e . l s   - l   A n d   a   s u b - l i s t   a f t e r   s o m e   b l o c k - l e v e l   c o n t e n t .   T h i s   i s   a t   t h e   s a m e   " l e v e l "   a s   t h e   p a r a g r a p h   a n d   c o d e   b l o c k   a b o v e ,   d e s p i t e   b e i n g   i n d e n t e d   m o r e .   T h i s   i s   a   n e w   l i s t .   W i t h   H u g o ,   y o u   n e e d   t o   u s e   a n   H T M L   c o m m e n t   t o   s e p a r a t e   t w o   c o n s e c u t i v e   l i s t s .   T h e   H T M L   c o m m e n t   n e e d s   t o   b e   a t   t h e   l e f t   m a r g i n .   N u m b e r e d   l i s t s   c a n   h a v e   p a r a g r a p h s   o r   b l o c k   e l e m e n t s   w i t h i n   t h e m .   I n d e n t   t h e   c o n t e n t   t o   b e   t h e   s a m e   a s   t h e   f i r s t   l i n e   o f   t h e   b u l l e t   p o i n t .   T h i s   p a r a g r a p h   a n d   t h e   c o d e   b l o c k   l i n e   u p   w i t h   t h e   N   i n   N u m b e r e d   a b o v e .   l s   - l   A n d   a   s u b - l i s t   a f t e r   s o m e   b l o c k - l e v e l   c o n t e n t .   T h i s   i s   a t   t h e   s a m e   " l e v e l "   a s   t h e   p a r a g r a p h   a n d   c o d e   b l o c k   a b o v e ,   d e s p i t e   b e i n g   i n d e


Question: What is Tab lists?

Answer: T a b   l i s t s   c a n   b e   u s e d   t o   c o n d i t i o n a l l y   d i s p l a y   c o n t e n t ,   e . g . ,   w h e n   m u l t i p l e   o p t i o n s   m u s t   b e   d o c u m e n t e d   t h a t   r e q u i r e   d i s t i n c t   i n s t r u c t i o n s   o r   c o n t e x t .   P l e a s e   s e l e c t   a n   o p t i o n .   P l e a s e   s e l e c t   a n   o p t i o n .   T a b s   m a y   a l s o   n e s t   f o r m a t t i n g   s t y l e s . O r d e r e d ( O r   u n o r d e r e d ) L i s t s e c h o   ' T a b   l i s t s   m a y   c o n t a i n   c o d e   b l o c k s ! '   T a b s   m a y   a l s o   n e s t   f o r m a t t i n g   s t y l e s .   O r d e r e d ( O r   u n o r d e r e d ) L i s t s   e c h o   ' T a b   l i s t s   m a y   c o n t a i n   c o d e   b l o c k s ! '   H e a d e r   w i t h i n   a   t a b   l i s t N e s t e d   h e a d e r   t a g s   m a y   a l s o   b e   i n c l u d e d . W a r n i n g : H e a d e r s   w i t h i n   t a b   l i s t s   w i l l   n o t   a p p e a r   i n   t h e   T a b l e   o f   C o n t e n t s .


Question: What is Header within a tab list?

Answer: N e s t e d   h e a d e r   t a g s   m a y   a l s o   b e   i n c l u d e d .


Question: What is Checklists?

Answer: C h e c k l i s t s   a r e   t e c h n i c a l l y   b u l l e t   l i s t s ,   b u t   t h e   b u l l e t s   a r e   s u p p r e s s e d   b y   C S S .   T h i s   i s   a   c h e c k l i s t   i t e m   T h i s   i s   a   s e l e c t e d   c h e c k l i s t   i t e m


Question: What is Code blocks?

Answer: Y o u   c a n   c r e a t e   c o d e   b l o c k s   t w o   d i f f e r e n t   w a y s   b y   s u r r o u n d i n g   t h e   c o d e   b l o c k   w i t h   t h r e e   b a c k - t i c k   c h a r a c t e r s   o n   l i n e s   b e f o r e   a n d   a f t e r   t h e   c o d e   b l o c k .   O n l y   u s e   b a c k - t i c k s   ( c o d e   f e n c e s )   f o r   c o d e   b l o c k s .   T h i s   a l l o w s   y o u   t o   s p e c i f y   t h e   l a n g u a g e   o f   t h e   e n c l o s e d   c o d e ,   w h i c h   e n a b l e s   s y n t a x   h i g h l i g h t i n g .   I t   i s   a l s o   m o r e   p r e d i c t a b l e   t h a n   u s i n g   i n d e n t a t i o n .   t h i s   i s   a   c o d e   b l o c k   c r e a t e d   b y   b a c k - t i c k s   T h e   b a c k - t i c k   m e t h o d   h a s   s o m e   a d v a n t a g e s .   I t   w o r k s   n e a r l y   e v e r y   t i m e . I t   i s   m o r e   c o m p a c t   w h e n   v i e w i n g   t h e   s o u r c e   c o d e . I t   a l l o w s   y o u   t o   s p e c i f y   w h a t   l a n g u a g e   t h e   c o d e   b l o c k   i s   i n ,   f o r   s y n t a x   h i g h l i g h t i n g . I t   h a s   a   d e f i n i t e   e n d i n g .   S o m e t i m e s ,   t h e   i n d e n t a t i o n   m e t h o d   b r e a k s   w i t h   l a n g u a g e s   w h e r e   s p a c i n g   i s   s i g n i f i c a n t ,   l i k e   P y t h o n   o r   Y A M L .   T o   s p e c i f y   t h e   l a n g u a g e   f o r   t h e   c o d e   b l o c k ,   p u t   i t   d i r e c t l y   a f t e r   t h e   f i r s t   g r o u p i n g   o f   b a c k - t i c k s :   l s   - l   C o m m o n   l a n g u a g e s   u s e d   i n   K u b e r n e t e s   d o c u m e n t a t i o n   c o d e   b l o c k s   i n c l u d e :   b a s h   /   s h e l l   ( b o t h   w o r k   t h e   s a m e ) g o j s o n y a m l x m l n o n e   ( d i s a b l e s   s y n t a x   h i g h l i g h t i n g   f o r   t h e   b l o c k )


Question: What is Code blocks containing Hugo shortcodes?

Answer: T o   s h o w   r a w   H u g o   s h o r t c o d e s   a s   i n   t h e   a b o v e   e x a m p l e   a n d   p r e v e n t   H u g o   f r o m   i n t e r p r e t i n g   t h e m ,   u s e   C - s t y l e   c o m m e n t s   d i r e c t l y   a f t e r   t h e   <   a n d   b e f o r e   t h e   >   c h a r a c t e r s .   T h e   f o l l o w i n g   e x a m p l e   i l l u s t r a t e s   t h i s   ( v i e w   t h e   M a r k d o w n   s o u r c e   f o r   t h i s   p a g e ) .   { { <   a l e r t   c o l o r = " w a r n i n g "   > } } T h i s   i s   a   w a r n i n g . { { <   / a l e r t   > } }


Question: What is Links?

Answer: T o   f o r m a t   a   l i n k ,   p u t   t h e   l i n k   t e x t   i n s i d e   s q u a r e   b r a c k e t s ,   f o l l o w e d   b y   t h e   l i n k   t a r g e t   i n   p a r e n t h e s e s .   [ L i n k   t o   K u b e r n e t e s . i o ] ( h t t p s : / / k u b e r n e t e s . i o / )   o r [ R e l a t i v e   l i n k   t o   K u b e r n e t e s . i o ] ( / )   Y o u   c a n   a l s o   u s e   H T M L ,   b u t   i t   i s   n o t   p r e f e r r e d .   F o r   e x a m p l e ,   < a   h r e f = " h t t p s : / / k u b e r n e t e s . i o / " > L i n k   t o   K u b e r n e t e s . i o < / a > .


Question: What is Images?

Answer: T o   f o r m a t   a n   i m a g e ,   u s e   s i m i l a r   s y n t a x   t o   l i n k s ,   b u t   a d d   a   l e a d i n g   !   c h a r a c t e r .   T h e   s q u a r e   b r a c k e t s   c o n t a i n   t h e   i m a g e ' s   a l t   t e x t .   T r y   t o   a l w a y s   u s e   a l t   t e x t   s o   t h a t   p e o p l e   u s i n g   s c r e e n   r e a d e r s   c a n   g e t   s o m e   b e n e f i t   f r o m   t h e   i m a g e .   ! [ p e n c i l   i c o n ] ( / i m a g e s / p e n c i l . p n g )   P r o d u c e s :   T o   s p e c i f y   e x t e n d e d   a t t r i b u t e s ,   s u c h   a s   w i d t h ,   t i t l e ,   c a p t i o n ,   e t c ,   u s e   t h e   f i g u r e   s h o r t c o d e ,   w h i c h   i s   p r e f e r r e d   t o   u s i n g   a   H T M L   < i m g >   t a g .   A l s o ,   i f   y o u   n e e d   t h e   i m a g e   t o   a l s o   b e   a   h y p e r l i n k ,   u s e   t h e   l i n k   a t t r i b u t e ,   r a t h e r   t h a n   w r a p p i n g   t h e   w h o l e   f i g u r e   i n   M a r k d o w n   l i n k   s y n t a x   a s   s h o w n   b e l o w .


Question: What is Pencil icon?

Answer: A n   i m a g e   u s e d   t o   i l l u s t r a t e   t h e   f i g u r e   s h o r t c o d e   E v e n   i f   y o u   c h o o s e   n o t   t o   u s e   t h e   f i g u r e   s h o r t c o d e ,   a n   i m a g e   c a n   a l s o   b e   a   l i n k .   T h i s   t i m e   t h e   p e n c i l   i c o n   l i n k s   t o   t h e   K u b e r n e t e s   w e b s i t e .   O u t e r   s q u a r e   b r a c k e t s   e n c l o s e   t h e   e n t i r e   i m a g e   t a g ,   a n d   t h e   l i n k   t a r g e t   i s   i n   t h e   p a r e n t h e s e s   a t   t h e   e n d .   [ ! [ p e n c i l   i c o n ] ( / i m a g e s / p e n c i l . p n g ) ] ( h t t p s : / / k u b e r n e t e s . i o )   P r o d u c e s :   Y o u   c a n   a l s o   u s e   H T M L   f o r   i m a g e s ,   b u t   i t   i s   n o t   p r e f e r r e d .   < i m g   s r c = " / i m a g e s / p e n c i l . p n g "   a l t = " p e n c i l   i c o n "   / >   P r o d u c e s :


Question: What is Tables?

Answer: S i m p l e   t a b l e s   h a v e   o n e   r o w   p e r   l i n e ,   a n d   c o l u m n s   a r e   s e p a r a t e d   b y   |   c h a r a c t e r s .   T h e   h e a d e r   i s   s e p a r a t e d   f r o m   t h e   b o d y   b y   c e l l s   c o n t a i n i n g   n o t h i n g   b u t   a t   l e a s t   t h r e e   -   c h a r a c t e r s .   F o r   e a s e   o f   m a i n t e n a n c e ,   t r y   t o   k e e p   a l l   t h e   c e l l   s e p a r a t o r s   e v e n ,   e v e n   i f   y o u   h e e d   t o   u s e   e x t r a   s p a c e .   T h e   h e a d e r   i s   o p t i o n a l .   A n y   t e x t   s e p a r a t e d   b y   |   w i l l   r e n d e r   a s   a   t a b l e .   M a r k d o w n   t a b l e s   h a v e   a   h a r d   t i m e   w i t h   b l o c k - l e v e l   e l e m e n t s   w i t h i n   c e l l s ,   s u c h   a s   l i s t   i t e m s ,   c o d e   b l o c k s ,   o r   m u l t i p l e   p a r a g r a p h s .   F o r   c o m p l e x   o r   v e r y   w i d e   t a b l e s ,   u s e   H T M L   i n s t e a d .   < t a b l e >   < t h e a d >   < t r >   < t h > H e a d i n g   c e l l   1 < / t h >   < t h > H e a d i n g   c e l l   2 < / t h >   < / t r >   < / t h e a d >   < t b o d y >   < t r >   < t d > B o d y   c e l l   1 < / t d >   < t d > B o d y   c e l l   2 < / t d >   < / t r >   < / t b o d y >   < / t a b l e >   P r o d u c e s :


Question: What is Visualizations with Mermaid?

Answer: Y o u   c a n   u s e   M e r m a i d   J S   v i s u a l i z a t i o n s .   T h e   M e r m a i d   J S   v e r s i o n   i s   s p e c i f i e d   i n   / l a y o u t s / p a r t i a l s / h e a d . h t m l   { { <   m e r m a i d   > } }   g r a p h   T D ;   A - - > B ;   A - - > C ;   B - - > D ;   C - - > D ;   { { < /   m e r m a i d   > } }   P r o d u c e s :   { { <   m e r m a i d   > } }   s e q u e n c e D i a g r a m   A l i c e   - > >   B o b :   H e l l o   B o b ,   h o w   a r e   y o u ?   B o b - - > > J o h n :   H o w   a b o u t   y o u   J o h n ?   B o b - - x   A l i c e :   I   a m   g o o d   t h a n k s !   B o b - x   J o h n :   I   a m   g o o d   t h a n k s !   N o t e   r i g h t   o f   J o h n :   B o b   t h i n k s   a   l o n g < b r / > l o n g   t i m e ,   s o   l o n g < b r / > t h a t   t h e   t e x t   d o e s < b r / > n o t   f i t   o n   a   r o w .   B o b - - > A l i c e :   C h e c k i n g   w i t h   J o h n . . .   A l i c e - > J o h n :   Y e s . . .   J o h n ,   h o w   a r e   y o u ?   { { < /   m e r m a i d   > } }   P r o d u c e s :   Y o u   c a n   c h e c k   m o r e   e x a m p l e s   f r o m   t h e   o f f i c i a l   d o c s .


Question: What is Sidebars and Admonitions?

Answer: S i d e b a r s   a n d   a d m o n i t i o n s   p r o v i d e   w a y s   t o   a d d   v i s u a l   i m p o r t a n c e   t o   t e x t .   U s e   t h e m   s p a r i n g l y .


Question: What is Sidebars?

Answer: A   s i d e b a r   o f f s e t s   t e x t   v i s u a l l y ,   b u t   w i t h o u t   t h e   v i s u a l   p r o m i n e n c e   o f   a d m o n i t i o n s .   T h i s   i s   a   s i d e b a r .   Y o u   c a n   h a v e   p a r a g r a p h s   a n d   b l o c k - l e v e l   e l e m e n t s   w i t h i n   a   s i d e b a r .   Y o u   c a n   e v e n   h a v e   c o d e   b l o c k s .   s u d o   d m e s g


Question: What is Admonitions?

Answer: A d m o n i t i o n s   ( n o t e s ,   w a r n i n g s ,   e t c )   u s e   H u g o   s h o r t c o d e s .


Question: What is Note:?

Answer: N o t e s   c a t c h   t h e   r e a d e r ' s   a t t e n t i o n   w i t h o u t   a   s e n s e   o f   u r g e n c y .   Y o u   c a n   h a v e   m u l t i p l e   p a r a g r a p h s   a n d   b l o c k - l e v e l   e l e m e n t s   i n s i d e   a n   a d m o n i t i o n .   Y o u   c a n   a l s o   a d d   t a b l e s   t o   o r g a n i z e   a n d   h i g h l i g h t   k e y   i n f o r m a t i o n .


Question: What is Includes?

Answer: T o   a d d   s h o r t c o d e s   t o   i n c l u d e s .