From 39e132b1fb3558343c0f14dc696e4e84928bd7a4 Mon Sep 17 00:00:00 2001
From: Loft Bot <73976634+loft-bot@users.noreply.github.com>
Date: Tue, 13 Dec 2022 16:57:49 +0000
Subject: [PATCH] [skip ci] repo-sync
---
docs/.gitignore | 2 -
docs/package.json | 4 +-
.../explore/restricting-access.mdx | 39 -
.../getting-started/explore/sleep-mode.mdx | 125 -
docs/pages/getting-started/explore/spaces.mdx | 204 --
docs/pages/getting-started/install.mdx | 2 +-
docs/pages/guides/preview-environments.mdx | 142 +
.../_partials/auto-delete/configure-ui.mdx | 16 +-
.../_partials/auto-delete/enforce-ui.mdx | 53 -
.../_partials/sleep/activity-detection.mdx | 25 +
.../sleep/advanced-configuration.mdx | 43 +
.../spaces/_partials/sleep/configure-ui.mdx | 13 +-
.../spaces/_partials/sleep/enforce-ui.mdx | 53 -
.../spaces/_partials/sleep/manual-cli.mdx | 14 +-
.../spaces/_partials/sleep/manual-ui.mdx | 18 +-
.../spaces/_partials/sleep/schedule-ui.mdx | 16 +-
.../pages/spaces/_partials/sleep/wake-cli.mdx | 10 +-
.../spaces/_partials/sleep/wake-kubectl.mdx | 4 -
docs/pages/spaces/_partials/sleep/wake-ui.mdx | 11 +-
.../sleep/working-with-sleep-mode.mdx | 8 +
docs/pages/spaces/sleep-mode.mdx | 86 +-
docs/pages/virtual-clusters/sleep-mode.mdx | 86 +-
docs/sidebars.js | 5 +
docs/yarn.lock | 2723 ++++++++++++++++-
24 files changed, 3002 insertions(+), 700 deletions(-)
delete mode 100644 docs/pages/getting-started/explore/restricting-access.mdx
delete mode 100644 docs/pages/getting-started/explore/sleep-mode.mdx
delete mode 100644 docs/pages/getting-started/explore/spaces.mdx
create mode 100644 docs/pages/guides/preview-environments.mdx
delete mode 100644 docs/pages/spaces/_partials/auto-delete/enforce-ui.mdx
create mode 100644 docs/pages/spaces/_partials/sleep/activity-detection.mdx
create mode 100644 docs/pages/spaces/_partials/sleep/advanced-configuration.mdx
delete mode 100644 docs/pages/spaces/_partials/sleep/enforce-ui.mdx
delete mode 100644 docs/pages/spaces/_partials/sleep/wake-kubectl.mdx
create mode 100644 docs/pages/spaces/_partials/sleep/working-with-sleep-mode.mdx
diff --git a/docs/.gitignore b/docs/.gitignore
index 21fdd0bf..27188607 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -37,8 +37,6 @@ node_modules/
/pages/architecture/
-/pages/guides/
-
/pages/integrations/cicd/terraform.mdx
/pages/integrations/policies/
/pages/integrations/devtools/
diff --git a/docs/package.json b/docs/package.json
index 0a968af1..dc9c2194 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -11,8 +11,8 @@
"serve": "npx -y nws -o -d build/ -b docs/ -p 8087"
},
"dependencies": {
- "@docusaurus/core": "2.0.0-beta.17",
- "@docusaurus/preset-classic": "2.0.0-beta.17",
+ "@docusaurus/core": "^2.2.0",
+ "@docusaurus/preset-classic": "^2.2.0",
"@saucelabs/theme-github-codeblock": "^0.1.1",
"classnames": "^2.2.6",
"docusaurus-plugin-sass": "^0.2.2",
diff --git a/docs/pages/getting-started/explore/restricting-access.mdx b/docs/pages/getting-started/explore/restricting-access.mdx
deleted file mode 100644
index c8871b6b..00000000
--- a/docs/pages/getting-started/explore/restricting-access.mdx
+++ /dev/null
@@ -1,39 +0,0 @@
----
-title: Quotas & Space Constraints
-sidebar_label: Restrict Users
----
-
-import PartialQuotasEnforceUI from '../../clusters/_partials/quotas/enforce-ui.mdx'
-import PartialSpaceContraintsCreateUI from '../../spaces/_partials/space-constraints/create-ui.mdx'
-import PartialSpaceContraintsEnforceUI from '../../spaces/_partials/space-constraints/enforce-ui.mdx'
-import PartialSleepEnforceUI from '../../spaces/_partials/sleep/enforce-ui.mdx'
-
-
-A key aspect of Loft is establishing secure multi-tenancy when sharing clusters among multiple users and teams. To guarantee fair use for every tenant and to isolate tenants from each other, Loft provides two features:
-- [Quotas](#quotas) which define aggregated resource limits for users and/or teams (e.g. max 5 spaces, max 12 GB memory)
-- [Space Constraints](#space-constraints) which define resources and other configurations that will be enforced for each space a user or a team creates using Loft (e.g. required labels and annotations, or resources such as a NetworkPolicy or LimitRange in each namespace)
-
-
-## Quotas
-
- 1. Create Space Constraints
-
-
-
- 2. Enforce Space Constraints For Users & Teams
-
-
-
-### Enforce Sleep Mode & Auto Delete
-
-
- Enforce Sleep Mode For All Spaces Created By User/Team
-
diff --git a/docs/pages/getting-started/explore/sleep-mode.mdx b/docs/pages/getting-started/explore/sleep-mode.mdx
deleted file mode 100644
index a755f1c4..00000000
--- a/docs/pages/getting-started/explore/sleep-mode.mdx
+++ /dev/null
@@ -1,125 +0,0 @@
----
-title: Sleep Mode & Auto-Delete in Loft
-sidebar_label: Sleep Mode
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem'
-
-import PartialSleepConfigureUI from '../../spaces/_partials/sleep/configure-ui.mdx'
-import PartialSleepEnforceUI from '../../spaces/_partials/sleep/enforce-ui.mdx'
-import PartialSleepManualUI from '../../spaces/_partials/sleep/manual-ui.mdx'
-import PartialSleepManualCLI from '../../spaces/_partials/sleep/manual-cli.mdx'
-import PartialSleepScheduleUI from '../../spaces/_partials/sleep/schedule-ui.mdx'
-import PartialSleepWakeUI from '../../spaces/_partials/sleep/wake-ui.mdx'
-import PartialSleepWakeCLI from '../../spaces/_partials/sleep/wake-cli.mdx'
-import PartialSleepWakeKubectl from '../../spaces/_partials/sleep/wake-kubectl.mdx'
-import PartialAutoDeleteConfigureUI from '../../spaces/_partials/auto-delete/configure-ui.mdx'
-import PartialAutoDeleteEnforceUI from '../../spaces/_partials/auto-delete/enforce-ui.mdx'
-
-
-Loft provides two powerful features to reduce Kubernetes cost:
-- [Sleep Mode](#sleep-mode) which puts namespaces to sleep when nobody is using them, i.e. purging all pods while keeping all resources inside the namespaces during periods of inactivity
-- [Auto-Delete](#auto-delete) which deletes namespaces that have been idle for a while
-
-Both of these feature typically rely on Loft's [inactivity detection](#inactivity-detection).
-
-
-## Sleep Mode
-With sleep mode, you can put Kubernetes namespaces to sleep which means that Loft will set `replicas: 0` for all replica-controlled resources such as `Deployments` and `StatefulSets`. This means that Kubernetes will delete all pods but the entire configuration of resources within the namespace is still there.
-
-Sleep mode can be:
-- Invoked manually
-- Triggered by an inactivity timeout (no one has ran a `kubectl` command in this namespace for X minutes)
-- Scheduled using a CRON syntax
-
-
-### Manual + Automatic Sleep / Wake-up
-
-
- Start Sleep (manual)
-
-
-
-:::tip Automatic Wakeup
-Note that the space will automatically wake up again, once you run a kubectl command within the space.
-:::
-
-
-
-
- Automatic Sleep Mode (individual space)
-
-
-
- Wake up space
-
-
-
-
-
-### Scheduled Sleep / Wake-up
-
-
- Scheduled Sleep & Wake-Up (individual space)
-
-
-
-### Enforce Sleep Settings
-
-
- Enforce Sleep Mode For All Spaces Created By User/Team
-
-
-
-## Auto-Delete
-Loft lets you configure an auto-delete for namespaces that have not been used for a certain period of time (inactivity).
-
-
- Configure Auto-Delete Timeout (individual space)
-
-
-
- Enforce Auto-Delete Timeout For All Space Created By User/Team
-
-
-
-## Inactivity Detection
-All requests that are made through Loft count as activity in the namespace.
-
-```mermaid
-flowchart LR;
- kubectl("kubectl get pod my-pod") --> Loft
-
- Loft("apiVersion: v1\nkind: Pod\nmetadata:\n name: my-pod\n... ")
-
- class kubectl code
- class Pod yaml
- class Loft loft
-```
-
-If your kube-context points to Loft's API server as a proxy before the actual connected cluster's API server, every `kubectl` request will be an activity and reset the inactivity timeout.
diff --git a/docs/pages/getting-started/explore/spaces.mdx b/docs/pages/getting-started/explore/spaces.mdx
deleted file mode 100644
index be142024..00000000
--- a/docs/pages/getting-started/explore/spaces.mdx
+++ /dev/null
@@ -1,204 +0,0 @@
----
-title: Self-Service Namespaces in Loft
-sidebar_label: Spaces
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem'
-
-import PartialSpaceDiagramNamespace from '../../spaces/_partials/diagrams/namespace.mdx'
-import PartialSpaceCreateUI from '../../spaces/_partials/space/create-ui.mdx'
-import PartialSpaceCreateCLI from '../../spaces/_partials/space/create-cli.mdx'
-import PartialSpaceDeleteUI from '../../spaces/_partials/space/delete-ui.mdx'
-import PartialSpaceDeleteCLI from '../../spaces/_partials/space/delete-cli.mdx'
-import PartialSpaceListUI from '../../spaces/_partials/space/list-ui.mdx'
-import PartialSpaceListCLI from '../../spaces/_partials/space/list-cli.mdx'
-import PartialSpaceListKubectl from '../../spaces/_partials/space/list-kubectl.mdx'
-import PartialSleepConfigureUI from '../../spaces/_partials/sleep/configure-ui.mdx'
-import PartialSleepEnforceUI from '../../spaces/_partials/sleep/enforce-ui.mdx'
-import PartialSleepManualUI from '../../spaces/_partials/sleep/manual-ui.mdx'
-import PartialSleepManualCLI from '../../spaces/_partials/sleep/manual-cli.mdx'
-import PartialSleepScheduleUI from '../../spaces/_partials/sleep/schedule-ui.mdx'
-import PartialSleepWakeUI from '../../spaces/_partials/sleep/wake-ui.mdx'
-import PartialSleepWakeCLI from '../../spaces/_partials/sleep/wake-cli.mdx'
-import PartialSleepWakeKubectl from '../../spaces/_partials/sleep/wake-kubectl.mdx'
-import PartialAutoDeleteConfigureUI from '../../spaces/_partials/auto-delete/configure-ui.mdx'
-import PartialAutoDeleteEnforceUI from '../../spaces/_partials/auto-delete/enforce-ui.mdx'
-import PartialSpaceTemplateCreateUI from '../../spaces/_partials/space-template/create-ui.mdx'
-import PartialSpaceTemplateInstantiateUI from '../../spaces/_partials/space-template/instantiate-ui.mdx'
-import PartialSpaceTemplateInstantiateCLI from '../../spaces/_partials/space-template/instantiate-cli.mdx'
-import PartialSpaceContraintsCreateUI from '../../spaces/_partials/space-constraints/create-ui.mdx'
-import PartialSpaceContraintsEnforceUI from '../../spaces/_partials/space-constraints/enforce-ui.mdx'
-import PartialSpaceShareUI from '../../spaces/_partials/space/share-ui.mdx'
-import PartialSpaceShareCLI from '../../spaces/_partials/space/share-cli.mdx'
-
-
-Spaces are virtual resources that represent regular Kubernetes namespaces. Typically, non-admin users to not have the permission to list, create or delete namespaces in a shared Kubernetes clusters. That's why Loft adds the space resource to Kubernetes. Spaces are not stored in etcd but rather abstract from regular namespaces. Deleting a space will effectively delete the underlying namespace, for example. In turn, any labels and annotations set on a namespace will show up on the corresponding space as well.
-
-
- Create Spaces
-
-
-
-
-
- Delete Spaces
-
-
-
-
-
- List Spaces
-
-
-
-
-
-## Sleep Mode
-With sleep mode, you can put Kubernetes namespaces to sleep which means that Loft will set `replicas: 0` for all replica-controlled resources such as `Deployments` and `StatefulSets`. This means that Kubernetes will delete all pods but the entire configuration of resources within the namespace is still there.
-
-
- Start Sleep (manual)
-
-
-
-:::tip Automatic Wakeup
-Note that the space will automatically wake up again, once you run a kubectl command within the space.
-:::
-
-
-
-
- Wake up space
-
-
-
-
-
- Automatic Sleep Mode (individual space)
-
-
-
- Scheduled Sleep & Wake-Up (individual space)
-
-
-
- Enforce Sleep Mode For All Spaces Created By User/Team
-
-
-
-## Auto-Delete
-Loft lets you configure an auto-delete for namespaces that have not been used for a certain period of time (inactivity).
-
-
- Configure Auto-Delete Timeout (individual space)
-
-
-
- Enforce Auto-Delete Timeout For All Space Created By User/Team
-
-
-
-## Space Templates
-Loft allows you to create templates for spaces. Unlike [Space Constraints](#space-constraints) which are enforced for a space, space templates are optional templates that a user can choose to apply when creating a space.
-
-Common use cases for space templates may be:
-- Adding development tooling to a namespace
-- Deploying pre-populated databases with test data
-- Equipping new namespaces with optional credentials such as image pull secrets
-
-:::caution Security Templates
-Do **not** use space templates for setting up security-related resources such as NetworkPolicies or LimitRanges. Instead, use **[Space Constraints](#space-constraints)** to enforce tenant isolation and other security measures.
-:::
-
-
- 1. Create Space Template
-
-
-
- 2. Use Space Template To Create A Space
-
-
-
-
-
-## Space Constraints
-Space Constraints allow you to define restrictions for namespaces such as enforced resources that will be deployed to each new namespace a user creates (e.g. NetworkPolicies) or other enforced settings such as mandatory labels, annotations, or any sleep mode configurations.
-
-
- 1. Create Space Constraints
-
-
-
- 2. Enforce Space Constraints For Users & Teams
-
-
-
-## Access Permissions
-Loft makes it easy to give other users or even entire teams access to one of your namespaces.
-
-
-
diff --git a/docs/pages/getting-started/install.mdx b/docs/pages/getting-started/install.mdx
index 7d4594c0..2791dae8 100644
--- a/docs/pages/getting-started/install.mdx
+++ b/docs/pages/getting-started/install.mdx
@@ -25,7 +25,7 @@ Use one of the following commands to download the Loft CLI binary from GitHub:
Make sure you are using the correct kube-context via `kubectl config current-context` and then run:
```bash
-loft start
+loft start --version v3.0.0-alpha.6
```
The CLI will ask for your email address to create the admin user and then deploy Loft to your
diff --git a/docs/pages/guides/preview-environments.mdx b/docs/pages/guides/preview-environments.mdx
new file mode 100644
index 00000000..2c8166cf
--- /dev/null
+++ b/docs/pages/guides/preview-environments.mdx
@@ -0,0 +1,142 @@
+---
+title: Preview Environments
+sidebar_label: Preview Environments
+---
+
+In this guide, we'll show how to use Loft and Github Actions to deploy preview environments for your application on every pull request. In this example we will create a new virtual cluster for each pull request and deploy ArgoCD into it. We'll make use of the sleep mode functionality of Loft to make sure the environments are not using any resources if they are unused.
+
+## Prepare Loft
+
+### Install Ingress Controller
+
+Make sure to install an ingress controller into the Kubernetes cluster where the preview environments should get created. We recommend [ingress-nginx](https://github.com/kubernetes/ingress-nginx) which can be installed through Loft under Cluster > Apps.
+
+### Configure Preview Environments Domain
+
+As a next step, make sure you have a wildcard domain configured under which the preview environments should be reachable, such as `*.my-preview-environments.com`. If you don't have access to a custom domain, Loft allows you to configure a `*.CUSTOM.kubedev.sh` domain in the Clusters > Cluster tab.
+
+### Create Virtual Cluster Template
+
+Next we create a new virtual cluster template for our preview environments. Navigate to Templates > Virtual Clusters and press on the 'Add Virtual Cluster Template' button. Make sure to use the following helm values:
+```yaml
+# Reuse the host ingress controller for your ingresses
+sync:
+ ingresses:
+ enabled: true
+
+# Make sure pods don't break out of the virtual cluster
+isolation:
+ enabled: true
+ networkPolicy:
+ enabled: false
+```
+
+Next make sure sleep mode is configured to start after 30-60 minutes.
+
+:::info Optional: Ingress Authentication
+In the Advanced Options tab, you can also enable 'Ingress Authentication' to only allow users that have access to your Loft instance to access the preview environments.
+:::
+
+### Create Preview Environments Project
+
+Next create a new project `preview` to host our preview environments by pressing the plus button under the projects view. Make sure to only select our just created template as an allowed template and assign yourself and all other users or teams you want to have access to the preview environments in the members tab.
+
+## Create a Github Deploy Action
+
+After we have our Loft project configured correctly, we can start creating the actual github action that will create our preview environments. On every pull request this action will create a new virtual cluster that hosts our example application (ArgoCD in this case) and can be accessed through an ingress.
+
+The github action looks like this:
+```yaml
+name: Create Preview Environment
+
+# Run for pull requests to our main branch
+on:
+ pull_request:
+ branches:
+ - main
+
+# make sure the pipeline is only running once
+concurrency:
+ group: preview-${{ github.head_ref || github.ref_name }}
+ cancel-in-progress: true
+
+# define a job that deploys the preview environment
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - name: checkout
+ uses: actions/checkout@v3
+
+ - name: Install Loft CLI
+ uses: loft-sh/setup-loft@v2
+ with:
+ version: v3.0.0
+ url: https://url-to-your-loft-instance.com
+ # Specify your Loft access key here
+ access-key: ${{ secrets.LOFT_PREVIEW_ACCESS_KEY }}
+ # Optional if your Loft domain certificate is insecure
+ #insecure: true
+
+ - name: Deploy Preview Environment
+ run: |
+ INGRESS_HOST=loft-preview-${{ github.event.pull_request.number }}.my-preview-environments.com
+
+ # Make sure to recreate if there is an already existing environment
+ loft create vcluster loft-preview-${{ github.event.pull_request.number }} --project preview --recreate
+
+ # Deploy the application here with an ingress
+ helm repo add argo https://argoproj.github.io/argo-helm
+ helm install argocd argo/argo-cd --version 5.16.3 \
+ --create-namespace \
+ -n argocd \
+ --set server.ingress.enabled=true \
+ --set server.ingress.hosts={$INGRESS_HOST}
+
+ - uses: marocchino/sticky-pull-request-comment@v2
+ with:
+ number: ${{ github.event.pull_request.number }}
+ header: release
+ message: |
+ Preview environment deployed at: http://loft-preview-${{ github.event.pull_request.number }}.my-preview-environments.com
+```
+
+## Create a destroy action
+
+We also want to cleanup environments if they are not needed anymore. In order to accomplish this, we create a separate workflow to cleanup the virtual cluster we have created for our preview environment as soon as the pull request is closed or merged:
+
+```yaml
+name: Destroy Preview Environment
+
+on:
+ pull_request:
+ branches:
+ - main
+ types:
+ - closed
+
+jobs:
+ destroy:
+ runs-on: ubuntu-latest
+ steps:
+ - name: checkout
+ uses: actions/checkout@v3
+
+ - name: Install Loft CLI
+ uses: loft-sh/setup-loft@v2
+ with:
+ version: v3.0.0
+ url: https://url-to-your-loft-instance.com
+ # Specify your Loft access key here
+ access-key: ${{ secrets.LOFT_PREVIEW_ACCESS_KEY }}
+ #insecure: true
+
+ - name: Destroy Preview Environment
+ run: |
+ loft delete vcluster loft-preview-${{ github.event.pull_request.number }} --project preview
+```
+
+## Conclusion
+
+And that's it, we built a complete flow for creating preview environments with Loft and GitHub actions! After creation, the preview environments will start sleeping if they are not used and consume no computing resources in the cluster. If you want to access a preview environment, just click on the link in the pull request comment and Loft will wake up the environment automatically. This way you can build preview environments that are fast to create, flexible like separate Kubernetes clusters and with no costs at all for unused environments.
+
diff --git a/docs/pages/spaces/_partials/auto-delete/configure-ui.mdx b/docs/pages/spaces/_partials/auto-delete/configure-ui.mdx
index 6933e74a..10500689 100644
--- a/docs/pages/spaces/_partials/auto-delete/configure-ui.mdx
+++ b/docs/pages/spaces/_partials/auto-delete/configure-ui.mdx
@@ -5,26 +5,20 @@ import Label from '@site/src/components/Label'
import Input from '@site/src/components/Input'
import Expander from '@site/src/components/Expander'
-import CreateSpaceStep1 from '@site/static/media/ui/screenshots/auth/login/login.png'
-import CreateSpaceStep2 from '@site/static/media/ui/screenshots/spaces/create-space/button-open-drawer.png'
-
- In the Spaces view, hover over space that you want to configure auto-delete for
-
-
- While hovering over the row, you will see buttons appear on the right in the Actions column
+ In the Projects > {props.name === "virtual cluster" ? "Virtual Clusters" : "Spaces"} view, hover over the {props.name} that you want to configure auto-delete for
- Click on the Edit the space
+ Click on the Edit button to Edit the {props.name}
- In the drawer that appears on the right, expand the Sleep Mode section
+ In the drawer that appears on the right, expand the Sleep Mode section. This only works for {props.name}s without a template, if you want to change the auto delete configuration for a {props.name} created by a template, please do the changes in the Templates view
- Use the Delete After Inactivity field to specify the Delete After Inactivity field to specify the time to wait before deleting the {props.name} if there was no more user activity within this {props.name}
- On the very bottom, click on the Update button to save the changes
+ On the very bottom, click on the Save Changes button to save the changes
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/auto-delete/enforce-ui.mdx b/docs/pages/spaces/_partials/auto-delete/enforce-ui.mdx
deleted file mode 100644
index 544e89ce..00000000
--- a/docs/pages/spaces/_partials/auto-delete/enforce-ui.mdx
+++ /dev/null
@@ -1,53 +0,0 @@
-import Flow, { Step } from '@site/src/components/Flow'
-import NavStep from '@site/src/components/NavStep'
-import Button from '@site/src/components/Button'
-import Label from '@site/src/components/Label'
-import Input from '@site/src/components/Input'
-import Expander from '@site/src/components/Expander'
-
-import CreateSpaceStep1 from '@site/static/media/ui/screenshots/auth/login/login.png'
-import CreateSpaceStep2 from '@site/static/media/ui/screenshots/spaces/create-space/button-open-drawer.png'
-
-
-
- Go to the Clusters view using the menu on the left
-
-
- Switch to the Space Constraints tab
-
-
-
-**Option A**: Hover over the space constraints object that you want to configure auto-delete with and click on the Edit an existing space constraints object
-
-**Option B**: Click the Create Space Constraints button to create a new space constraints object
-
-
-
- In the drawer that appears on the right, expand the Enforce Space Settings section
-
-
- Use the Delete After Inactivity field to specify the
-
- On the very bottom, click on the Update or Create button to save the changes
-
-
- Switch to the Cluster Access tab
-
-
- Hover over the cluster access of the user or team that you want to enforce auto-delete for and click on the Edit the cluster access
-
-
- In the drawer that appears on the right, expand the Restrictions section
-
-
- Use the Enforce Space Constraints field to select the
-
- On the very bottom, click on the Update button to update the cluster access
-
-
-
-:::tip Test with Impersonation
-After following the steps above, all spaces created using the cluster access in step 7 will now enforce this auto-delete behavior. You can test this behavior by impersonating a user that uses this cluster access.
-:::
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/sleep/activity-detection.mdx b/docs/pages/spaces/_partials/sleep/activity-detection.mdx
new file mode 100644
index 00000000..433a7106
--- /dev/null
+++ b/docs/pages/spaces/_partials/sleep/activity-detection.mdx
@@ -0,0 +1,25 @@
+All requests that are made through Loft count as activity in the {props.name} .
+
+```mermaid
+flowchart LR;
+ kubectl("kubectl get pod my-pod") --> Loft
+
+ Loft("apiVersion: v1\nkind: Pod\nmetadata:\n name: my-pod\n... ")
+
+ class kubectl code
+ class Pod yaml
+ class Loft loft
+```
+
+If your kube-context points to Loft's API server as a proxy before the actual connected cluster's API server, every `kubectl` request will be an activity and reset the inactivity timeout.
+
+### Ingress Requests
+
+For ingress-nginx based ingresses, activity detection also works automatically. Other ingress controllers are currently not supported. For nginx based ingresses, Loft will add a special annotation to each ingress that will track activity and reset the timer as soon as a request is made to that ingress.
+
+:::info Ingress Wakeup
+Loft supports waking up a {props.name} through an ingress independent of the underlying ingress controller. Just navigate to the ingress host and you should see a Loft wakeup page for the {props.name}.
+:::
diff --git a/docs/pages/spaces/_partials/sleep/advanced-configuration.mdx b/docs/pages/spaces/_partials/sleep/advanced-configuration.mdx
new file mode 100644
index 00000000..f22dfad7
--- /dev/null
+++ b/docs/pages/spaces/_partials/sleep/advanced-configuration.mdx
@@ -0,0 +1,43 @@
+
+### Exclude Resources From Sleep
+Loft allows you to specify resources that should not sleep within a space by providing the annotation sleepmode.loft.sh/exclude: 'true' on either a Deployment, StatefulSet, ReplicaSet or Pod. For example the following Deployment would not sleep if the space is sleeping:
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: test
+ annotations:
+ sleepmode.loft.sh/exclude: 'true'
+spec:
+ replicas: 2
+ selector:
+ matchLabels:
+ app: test
+ template:
+ metadata:
+ labels:
+ app: test
+ spec:
+ containers:
+ - name: busybox
+ image: busybox
+ command:
+ - sleep
+ - '3600'
+```
+
+### Long-Living Connections
+
+It's possible that certain requests such as kubectl exec or kubectl port-forward keep an active connection open to the {props.name} that prevents it from sleeping. This is in most cases wanted since the {props.name} shouldn't start sleeping when someone is still clearly using it, however there are cases where the connection might be idle (someone left the laptop open, but is not using it anymore) in which you want to terminate such connections and put the {props.name} to sleep.
+There are multiple ways to approach this problem of active connections preventing a {props.name} from sleeping:
+
+You can tell loft to timeout idle streaming connections (such as kubectl exec, kubectl port-forward etc.) after a certain time period with the annotation loft.sh/streaming-connection-idle-timeout: '3600' on a **cluster**. With this annotation set, loft will close connections automatically that are idle after the given seconds. By default, Loft will not timeout any connections. This will only apply to new opened connections to that cluster and not affect already running connections.
+
+ Set annotation on cluster
+
+
+Tell loft to ignore all active connections for determining {props.name} activity via the annotation sleepmode.loft.sh/ignore-active-conntections: 'true'. This will put a {props.name} to sleep even though there still might be open connections such as kubectl exec or kubectl port-forward.
+Configure your kubelets with the flag --streaming-connection-idle-timeout duration(see docs ). This behaves essentially as option 1, however this configuration is Loft independent.
+
diff --git a/docs/pages/spaces/_partials/sleep/configure-ui.mdx b/docs/pages/spaces/_partials/sleep/configure-ui.mdx
index 62ee24ea..50388bdb 100644
--- a/docs/pages/spaces/_partials/sleep/configure-ui.mdx
+++ b/docs/pages/spaces/_partials/sleep/configure-ui.mdx
@@ -10,21 +10,18 @@ import CreateSpaceStep2 from '@site/static/media/ui/screenshots/spaces/create-sp
- In the Spaces view, hover over space that you want to configure automatic sleep mode for
+ In the Projects > {props.name === "virtual cluster" ? "Virtual Clusters" : "Spaces"} view, hover over the {props.name} that you want to configure automatic sleep mode for
- While hovering over the row, you will see buttons appear on the right in the Actions column
+ Click on the Edit button to Edit the {props.name}
- Click on the Edit the space
+ In the drawer that appears on the right, expand the Sleep Mode section. This only works for {props.name}s without a template, if you want to change the sleep mode configuration for a {props.name} created by a template, please do the changes in the Templates view
- In the drawer that appears on the right, expand the Sleep Mode section
+ Use the Sleep After Inactivity field to specify the time to wait before putting the {props.name} to sleep if there is no more user activity in this {props.name}
- Use the Sleep After Inactivity field to specify the
-
- On the very bottom, click on the Update button to save the changes
+ On the very bottom, click on the Save Changes button to save the changes
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/sleep/enforce-ui.mdx b/docs/pages/spaces/_partials/sleep/enforce-ui.mdx
deleted file mode 100644
index 03448e8d..00000000
--- a/docs/pages/spaces/_partials/sleep/enforce-ui.mdx
+++ /dev/null
@@ -1,53 +0,0 @@
-import Flow, { Step } from '@site/src/components/Flow'
-import NavStep from '@site/src/components/NavStep'
-import Button from '@site/src/components/Button'
-import Label from '@site/src/components/Label'
-import Input from '@site/src/components/Input'
-import Expander from '@site/src/components/Expander'
-
-import CreateSpaceStep1 from '@site/static/media/ui/screenshots/auth/login/login.png'
-import CreateSpaceStep2 from '@site/static/media/ui/screenshots/spaces/create-space/button-open-drawer.png'
-
-
-
- Go to the Clusters view using the menu on the left
-
-
- Switch to the Space Constraints tab
-
-
-
-**Option A**: Hover over the space constraints object that you want to configure automatic sleep mode with and click on the Edit an existing space constraints object
-
-**Option B**: Click the Create Space Constraints button to create a new space constraints object
-
-
-
- In the drawer that appears on the right, expand the Enforce Space Settings section
-
-
- Use the Sleep After Inactivity field to specify the
-
- On the very bottom, click on the Update or Create button to save the changes
-
-
- Switch to the Cluster Access tab
-
-
- Hover over the cluster access of the user or team that you want to configure automatic sleep mode for and click on the Edit the cluster access
-
-
- In the drawer that appears on the right, expand the Restrictions section
-
-
- Use the Enforce Space Constraints field to select the
-
- On the very bottom, click on the Update button to update the cluster access
-
-
-
-:::tip Test with Impersonation
-After following the steps above, all spaces created using the cluster access in step 7 will now enforce sleep mode. You can test this behavior by impersonating a user that uses this cluster access.
-:::
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/sleep/manual-cli.mdx b/docs/pages/spaces/_partials/sleep/manual-cli.mdx
index 115bab96..7ad3fb67 100644
--- a/docs/pages/spaces/_partials/sleep/manual-cli.mdx
+++ b/docs/pages/spaces/_partials/sleep/manual-cli.mdx
@@ -1,4 +1,10 @@
-To put a space to sleep using Loft CLI, run:
-```bash
-loft sleep space [name]
-```
\ No newline at end of file
+import CodeBlock from '@theme/CodeBlock';
+
+To put a {props.name} to sleep using Loft CLI, run:
+
+loft sleep {props.name === "virtual cluster" ? "vcluster" : "space"} [name]
+
+
+:::tip Automatic Wakeup
+Note that the {props.name} will automatically wake up again, once you run a kubectl command or send a Kubernetes request via another tool to the the {props.name}.
+:::
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/sleep/manual-ui.mdx b/docs/pages/spaces/_partials/sleep/manual-ui.mdx
index abb8a612..cd5b5e27 100644
--- a/docs/pages/spaces/_partials/sleep/manual-ui.mdx
+++ b/docs/pages/spaces/_partials/sleep/manual-ui.mdx
@@ -3,20 +3,18 @@ import NavStep from '@site/src/components/NavStep'
import Button from '@site/src/components/Button'
import Label from '@site/src/components/Label'
-import CreateSpaceStep1 from '@site/static/media/ui/screenshots/auth/login/login.png'
-import CreateSpaceStep2 from '@site/static/media/ui/screenshots/spaces/create-space/button-open-drawer.png'
-
- In the Spaces view, hover over the row of the space that you want to put to sleep
-
-
- While hovering over the row, you will see buttons appear on the right in the Actions column
+ In the Projects > {props.kind}s view, hover over the row of the {props.name} that you want to put to sleep
- Click on the Sleep
+ Click on the Sleep button to put the {props.name} to Sleep
- Notice how the Status column shows that the space is now sleeping.
+ Notice how the Status column shows that the {props.name} is now sleeping.
-
\ No newline at end of file
+
+
+:::tip Automatic Wakeup
+Note that the {props.name} will automatically wake up again, once you run a kubectl command or send a Kubernetes request via another tool to the the {props.name}.
+:::
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/sleep/schedule-ui.mdx b/docs/pages/spaces/_partials/sleep/schedule-ui.mdx
index c301ecbd..996a332b 100644
--- a/docs/pages/spaces/_partials/sleep/schedule-ui.mdx
+++ b/docs/pages/spaces/_partials/sleep/schedule-ui.mdx
@@ -5,29 +5,23 @@ import Label from '@site/src/components/Label'
import Input from '@site/src/components/Input'
import Expander from '@site/src/components/Expander'
-import CreateSpaceStep1 from '@site/static/media/ui/screenshots/auth/login/login.png'
-import CreateSpaceStep2 from '@site/static/media/ui/screenshots/spaces/create-space/button-open-drawer.png'
-
- In the Spaces view, hover over space that you want to configure automatic sleep mode for
-
-
- While hovering over the row, you will see buttons appear on the right in the Actions column
+ In the Projects > {props.name === "virtual cluster" ? "Virtual Clusters" : "Spaces"} view, hover over {props.name} that you want to configure automatic sleep mode for
- Click on the Edit the space
+ Click on the Edit button to Edit the {props.name}
- In the drawer that appears on the right, expand the Sleep Mode section
+ In the drawer that appears on the right, expand the Sleep Mode {props.name}. This only works for {props.name}s without a template, if you want to change the sleep mode configuration for a {props.name} created by a template, please do the changes in the Templates view
Expand the Sleep & Wake-Up Schedule section
- Use the Sleep Schedule field and/or the Wake-Up Schedule field to specify the Sleep Schedule field and/or the Wake-Up Schedule field to specify the
- On the very bottom, click on the Update button to save the changes
+ On the very bottom, click on the Save Changes button to save the changes
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/sleep/wake-cli.mdx b/docs/pages/spaces/_partials/sleep/wake-cli.mdx
index a0ee8bc6..bd97289b 100644
--- a/docs/pages/spaces/_partials/sleep/wake-cli.mdx
+++ b/docs/pages/spaces/_partials/sleep/wake-cli.mdx
@@ -1,4 +1,6 @@
-To wake up a sleeping space using Loft CLI, run:
-```bash
-loft wakeup space [name]
-```
\ No newline at end of file
+import CodeBlock from '@theme/CodeBlock';
+
+To wake up a sleeping {props.name} using Loft CLI, run:
+
+loft wakeup {props.name === "virtual cluster" ? "vcluster" : "space"} [name]
+
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/sleep/wake-kubectl.mdx b/docs/pages/spaces/_partials/sleep/wake-kubectl.mdx
deleted file mode 100644
index 3465a0ff..00000000
--- a/docs/pages/spaces/_partials/sleep/wake-kubectl.mdx
+++ /dev/null
@@ -1,4 +0,0 @@
-To wake up a sleeping space using kubectl, run:
-```bash
-kubectl get pods # or any other kubectl command within the namespace
-```
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/sleep/wake-ui.mdx b/docs/pages/spaces/_partials/sleep/wake-ui.mdx
index 81df989d..3b575fe3 100644
--- a/docs/pages/spaces/_partials/sleep/wake-ui.mdx
+++ b/docs/pages/spaces/_partials/sleep/wake-ui.mdx
@@ -3,20 +3,17 @@ import NavStep from '@site/src/components/NavStep'
import Button from '@site/src/components/Button'
import Label from '@site/src/components/Label'
-import CreateSpaceStep1 from '@site/static/media/ui/screenshots/auth/login/login.png'
-import CreateSpaceStep2 from '@site/static/media/ui/screenshots/spaces/create-space/button-open-drawer.png'
-
- In the Spaces view, hover over the Status column of the space that you want to put to sleep
+ In the Projects > {props.name === "virtual cluster" ? "Virtual Clusters" : "Spaces"} view, hover over the Status column of the {props.name} that you want to wake up
- While hovering over the row, you will see a tooltip appear that provide information about the sleep state of this space
+ While hovering over the row, you will see a tooltip appear that provide information about the sleep state of this {props.name}
- Click on the Wakeup button to wakeup the space
+ Click on the Wakeup button to wakeup the {props.name}
- Notice how the Status column shows that the space is now Active again.
+ Notice how the Status column shows that the {props.name} is now running again.
\ No newline at end of file
diff --git a/docs/pages/spaces/_partials/sleep/working-with-sleep-mode.mdx b/docs/pages/spaces/_partials/sleep/working-with-sleep-mode.mdx
new file mode 100644
index 00000000..87354d23
--- /dev/null
+++ b/docs/pages/spaces/_partials/sleep/working-with-sleep-mode.mdx
@@ -0,0 +1,8 @@
+With sleep mode, you can put {props.name}s to sleep which means that Loft will set replicas: 0 for all replica-controlled resources such as Deployments and StatefulSets inside the {props.name}. This means that Kubernetes will delete all pods but the entire configuration of resources within the {props.name} is still there.
+
+Sleep mode can be:
+
+Invoked manually
+Triggered by an inactivity timeout (no one has ran a kubectl command or accessed an ingress in this {props.name} for X minutes)
+Scheduled using a CRON syntax
+
\ No newline at end of file
diff --git a/docs/pages/spaces/sleep-mode.mdx b/docs/pages/spaces/sleep-mode.mdx
index e1ea6665..080e6659 100644
--- a/docs/pages/spaces/sleep-mode.mdx
+++ b/docs/pages/spaces/sleep-mode.mdx
@@ -3,4 +3,88 @@ title: Sleep Mode
sidebar_label: Sleep Mode
---
-Wait until refactoring of Sleep Mode is done.
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem'
+
+import PartialActivityDetection from './_partials/sleep/activity-detection.mdx'
+import PartialAdvancedConfiguration from './_partials/sleep/advanced-configuration.mdx'
+import PartialWorkingWithSleepMode from './_partials/sleep/working-with-sleep-mode.mdx'
+import PartialSleepConfigureUI from './_partials/sleep/configure-ui.mdx'
+import PartialSleepManualUI from './_partials/sleep/manual-ui.mdx'
+import PartialSleepManualCLI from './_partials/sleep/manual-cli.mdx'
+import PartialSleepScheduleUI from './_partials/sleep/schedule-ui.mdx'
+import PartialSleepWakeUI from './_partials/sleep/wake-ui.mdx'
+import PartialSleepWakeCLI from './_partials/sleep/wake-cli.mdx'
+import PartialAutoDeleteConfigureUI from './_partials/auto-delete/configure-ui.mdx'
+
+
+Loft provides two powerful features to reduce Kubernetes cost:
+- Sleep Mode which puts spaces to sleep when nobody is using them, i.e. purging all pods while keeping all resources inside the spaces during periods of inactivity
+- Auto-Delete which deletes spaces that have been idle for a while
+
+Both of these feature typically rely on Loft's [inactivity detection](#inactivity-detection).
+
+
+## Working with Sleep Mode
+
+
+ Start Sleep (manual)
+
+
+
+
+
+
+ Automatic Sleep Mode (individual space)
+
+
+
+ Wake up space
+
+
+
+
+
+### Scheduled Sleep / Wake-up
+
+
+ Scheduled Sleep & Wake-Up (individual space)
+
+
+
+## Working with Auto-Delete
+Loft lets you configure an auto-delete for spaces that have not been used for a certain period of time (inactivity).
+
+
+ Configure Auto-Delete Timeout
+
+
+
+## Inactivity Detection
+
+
+ Start Sleep (manual)
+
+
+
+
+
+
+ Automatic Sleep Mode (individual virtual cluster)
+
+
+
+ Wake up virtual cluster
+
+
+
+
+
+### Scheduled Sleep / Wake-up
+
+
+ Scheduled Sleep & Wake-Up (individual space)
+
+
+
+## Working with Auto-Delete
+Loft lets you configure an auto-delete for virtual clusters that have not been used for a certain period of time (inactivity).
+
+
+ Configure Auto-Delete Timeout
+
+
+
+## Inactivity Detection
+
+ 
")
-
- Loft --> Cluster("Connected Cluster 
+