- sleep mode

Signed-off-by: Weijie <[email protected]>

Author: ovaldi

docs/guides/sleep-mode-en.md

@@ -0,0 +1,51 @@
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+# Sleep Mode
+
+Sleep mode is the act of scaling the replicas of a workload to 0 for a specified period of time. With sleep mode, you can put the DevSpace to sleep which means that Kubernetes will delete all pods but the entire configuration within the DevSpace is still there.
+
+## What workloads support sleep?
+
+* `StatefulSet`
+* `Deployment`
+* `CronJob`
+
+## How to sleep/wakeup?
+
+You can trigger sleep/wakeup in three different ways.
+
+* In the `DevSpace` management page, customize the sleep time period, and the eligible `DevSpace` will automatically trigger sleep/wakeup.
+<figure className="img-frame">
+  <img className="gif-img" src={useBaseUrl('/img/sleep/custom.png')} />
+</figure>
+
+* In the `DevSpace` management page, manually trigger sleep/wakeup.
+<figure className="img-frame">
+  <img className="gif-img" src={useBaseUrl('/img/sleep/dashboard.png')} />
+</figure>
+
+* In JetBrains Plugin / VSCode Plugin, manually trigger sleep/wakeup.
+<figure className="img-frame">
+  <img className="gif-img" src={useBaseUrl('/img/sleep/jetbrains.png')} />
+</figure>
+
+## How does `sleep` works?
+
+- `StatefulSet`: set `spec.replicas: 0`
+- `Deployment`: set `spec.replicas: 0`
+- `CronJob`: set `spec.suspend: true`
+
+## How does `wakeup` works?
+
+- `StatefulSet`: restore `spec.replicas`
+- `Deployment`: restore `spec.replicas`
+- `CronJob`: set `spec.suspend: false`
+
+## Notes
+
+- By default, `Nocalhost` performs a round of sleep checks every `10s`.
+- Workloads that are already in `DevMode` will be ignored and will not be sleep.
+- `DevSpace` that are manually sleep by the user will not automatically wakeup that day.
+- `DevSpace` that are manually wakeup by the user will not automatically sleep that day.
+- When the user clears all sleep settings, the `DevSpace` that has gone into sleep will automatically wakeup.
+

docs/guides/sleep-mode.md

@@ -0,0 +1,51 @@
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+# 休眠模式
+
+休眠模式是在指定的时间内将工作负载副本数缩为 0 的一种行为，通过休眠模式，您可以让开发空间进入睡眠状态，这意味着 Kubernetes 将删除所有 pods，但开发空间内的资源配置仍然存在。
+
+## 支持休眠的工作负载类型
+
+* `StatefulSet`
+* `Deployment`
+* `CronJob`
+
+## 如何休眠/唤醒？
+
+您可以通过以下三种不同的方式触发休眠/唤醒：
+
+* 在 `DevSpace` 管理页面，自定义休眠时间段，符合条件的开发空间将自动触发休眠/唤醒。
+
+<figure className="img-frame">
+  <img className="gif-img" src={useBaseUrl('/img/sleep/custom.png')} />
+</figure>
+
+* 在 `DevSpace` 管理页面，手动触发休眠/唤醒。
+<figure className="img-frame">
+  <img className="gif-img" src={useBaseUrl('/img/sleep/dashboard.png')} />
+</figure>
+
+* 在 JetBrains 插件 / VSCode 插件，手动触发休眠/唤醒。
+<figure className="img-frame">
+  <img className="gif-img" src={useBaseUrl('/img/sleep/jetbrains.png')} />
+</figure>
+
+## 休眠原理
+
+- `StatefulSet`: 设置 `spec.replicas: 0`
+- `Deployment`: 设置 `spec.replicas: 0`
+- `CronJob`: 设置 `spec.suspend: true`
+
+## 唤醒原理
+
+- `StatefulSet`: 恢复 `spec.replicas`
+- `Deployment`: 恢复 `spec.replicas`
+- `CronJob`: 设置 `spec.suspend: false`
+
+## 注意事项
+
+- 默认情况下，`Nocalhost`每隔`10s`执行一轮休眠检查。
+- 已进入 `DevMode` 的工作负载，将会被忽略，不执行休眠处理；
+- 用户手动休眠的开发空间，当天将不会自动唤醒；
+- 用户手动唤醒的开发空间，当天将不会自动休眠；
+- 当用户清除所有休眠时间设定，已进入休眠的开发空间将被自动唤醒；

sidebars.js

@@ -69,6 +69,7 @@ module.exports = {
         'guides/remote-run',
         // Hot Reload
         'guides/hot-reload',
+        'guides/sleep-mode',
         // 'guides/clear-pvc',
       ]
     },