Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update shoot hibernation How-To in light of k8s update #269

Merged
merged 1 commit into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/howto/kubernetes/gardener/assets/garhiber-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/kubernetes/gardener/assets/garhiber-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/kubernetes/gardener/assets/garhiber-03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/kubernetes/gardener/assets/garhiber-04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/kubernetes/gardener/assets/garhiber-05.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/kubernetes/gardener/assets/garhiber-06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/howto/kubernetes/gardener/assets/garhiber-07.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 24 additions & 35 deletions docs/howto/kubernetes/gardener/hibernate-shoot-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,69 +3,58 @@ description: How to hibernate a Gardener-based Kubernetes cluster
---
# Hibernating a Kubernetes cluster

There will be times when you won't be using your {{k8s_management_service}}-based cluster
much, if at all. To save on costs, you can put the whole cluster in
hibernation. If you do, then from that time on (and until you wake the
cluster again), you will be paying *less* for the cluster.
There will be times when you won't be using your {{k8s_management_service}}-based cluster much, if at all.
To save on costs, you can put the whole cluster in hibernation.
If you do, then from that time on (and until you wake the cluster again), you will be paying *less* for the cluster.

## Prerequisites

We assume you have already used {{brand_container_orchestration}} to spin up a
Kubernetes cluster, which is now humming away. If you've never done
this before, please feel free to [follow this
guide](create-shoot-cluster.md).
We assume you have already used {{brand_container_orchestration}} to spin up a Kubernetes cluster, which is now humming away.
If you've never done this before, please feel free to [follow this guide](create-shoot-cluster.md).

## Hibernating a cluster

Fire up your favorite web browser and navigate to
<https://{{gui_domain}}>. Make sure the vertical pane at the left-hand
side of the page is in full view, then choose
*Containers → [{{k8s_management_service}}](https://{{gui_domain}}/containers/gardener)*.
In the main pane, you will see your {{k8s_management_service}} cluster. Click anywhere
on the corresponding row for a detailed view of the various cluster
characteristics. Go to the *Status* tab and check if hibernation is
possible.
Fire up your favorite web browser and navigate to <https://{{gui_domain}}>.
Make sure the vertical pane at the left-hand side of the page is in full view, then choose *Containers → [{{k8s_management_service}}](https://{{gui_domain}}/containers/gardener)*.
In the main pane, you will see your {{k8s_management_service}} cluster.
Click anywhere on its row for a detailed view of the various cluster characteristics.
Bring up the *Status* tab and, in the *Constraints* section, check whether hibernation is possible.
In the example below we have a shoot cluster based on Kubernetes 1.27, the latest supported at the time of this writing, and hibernation is indeed possible.

![{{k8s_management_service}} cluster status](assets/garhiber-01.png)

If hibernation is indeed possible, this will be reflected in the
*Constraints* section. To go ahead and actually hibernate the cluster,
click the orange three-dot icon at the right-hand side of the cluster
row, and from the pop-up menu that appears, select *Hibernate Cluster*.
To go ahead and actually hibernate the cluster, click the orange :material-dots-horizontal-circle: icon at the right-hand side of the cluster row.
From the pop-up menu that appears, select *Hibernate Cluster*.

![Hibernate cluster](assets/garhiber-02.png)

A big pop-up window will appear, asking you to confirm the action.
A big pop-up window labeled *About to hibernate a gardener shoot* appears, asking you to confirm the action.
colder-is-better marked this conversation as resolved.
Show resolved Hide resolved
Click the red button labeled *Yes, Hibernate*.

![Confirm cluster hibernation](assets/garhiber-03.png)

After a minute or two, the cluster will be in a hibernated state. This
fact will be indicated by the white-square-in-red-circle icon, at the
left-hand side of the cluster row.
After a minute or two, the cluster will be in a hibernated state.
This fact will be indicated by the red :material-stop-circle: icon, at the left-hand side of the cluster row.

![Cluster in hibernation](assets/garhiber-04.png)

At this point, and as long as the cluster is in hibernation, any
attempt to list the cluster nodes, e.g., via `kubectl`, will fail.
From this point on, and as long as the cluster is in hibernation, any attempt to list the cluster nodes, e.g., via `kubectl`, will fail.

## Waking up a cluster in hibernation

To wake up a cluster in hibernation, click the orange three-dot icon
at the right-hand side of its row. From the pop-up menu that appears,
select *Wake up Cluster*.
To wake up a cluster in hibernation, click the orange :material-dots-horizontal-circle: icon at the right-hand side of its row.
From the pop-up menu that appears, select *Wake up Cluster*.

![Wake up cluster](assets/garhiber-05.png)

A big pop-up window will appear, asking you to confirm that you want
to wake the cluster. Go ahead and click the red *Yes, Wakeup* button.
A big pop-up window labeled *About to wakeup a gardener shoot* appears, asking you to confirm that you want to wake the cluster.
Go ahead and click the red *Yes, Wakeup* button.

![Confirm cluster wake-up](assets/garhiber-06.png)

After a couple of minutes, the cluster will be fully awake. The fact
will be indicated by the white-tick-in-green-circle icon, at the
left-hand side of the cluster row.
After a couple of minutes, the cluster will be fully awake.
The fact will be indicated by the green :material-check-circle: icon, at the left-hand side of the cluster row.

![Cluster awake](assets/garhiber-07.png)

From that time on, the cluster will be accessible and fully operational again.
From that time on, the cluster will be fully operational and accessible again.