Skip to content
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
13 changes: 4 additions & 9 deletions platform/_partials/sleep/activity-detection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,23 @@ env:

All virtual cluster Kubernetes API requests that are made through the platform count as activity in the {props.name}.


<!-- vale off -->
```mermaid
flowchart LR;
kubectl("<code>$ kubectl get pod my-pod</code>") --> Platform

Platform("vCluster Platform")

Platform --> Cluster("Connected Cluster <br/> Kubernetes API Server")
Cluster --> Pod("apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: my-pod<br/>...")

class kubectl code
class Pod yaml
class Platform platform
Cluster --> Pod("<div style='text-align:left; margin:0px;'>apiVersion:&nbsp;v1<br/>kind: Pod<br/>metadata:<br/>&nbsp;&nbsp;name: my-pod<br/></div>")
```
<!-- vale on -->

If your kube-context points to the platform'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, the platform will add a special annotation to each ingress that will track activity and reset the timer when a request is made to that ingress.
For [ingress-nginx](https://github.com/kubernetes/ingress-nginx/tree/main) based Ingresses and [Istio](https://istio.io/) Gateways, activity detection works automatically.
For nginx based ingresses, the platform adds the [mirror-target](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md#mirror) annotation to each ingress that will track activity and reset the timer when a request is made to that ingress.
For Istio, the metrics from the istio-proxy container are used to determine activity.

<br></br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,21 @@ flowchart LR;
Platform("vCluster Platform")

Platform --> Cluster("Connected Cluster <br/> Kubernetes API Server")
Cluster --> Pod("apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: my-pod<br/>...")

class kubectl code
class Pod yaml
class Platform platform
Cluster --> Pod("<div style='text-align:left; margin:0px;'>apiVersion:&nbsp;v1<br/>kind: Pod<br/>metadata:<br/>&nbsp;&nbsp;name: my-pod<br/></div>")
```

If your kube-context points to the platform'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, the platform 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.
For [ingress-nginx](https://github.com/kubernetes/ingress-nginx/tree/main) based Ingresses and [Istio](https://istio.io/) Gateways, activity detection works automatically.
For nginx based ingresses, the platform adds the [mirror-target](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md#mirror) annotation to each ingress that will track activity and reset the timer when a request is made to that ingress.
For Istio, the metrics from the istio-proxy container are used to determine activity.

<br></br>

:::info Ingress Wakeup

vCluster Platform 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 wakeup page for the {props.name}.

:::
:::
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,16 @@ flowchart LR;
Platform("vCluster Platform")

Platform --> Cluster("Connected Cluster <br/> Kubernetes API Server")
Cluster --> Pod("apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: my-pod<br/>...")

class kubectl code
class Pod yaml
class Platform platform
Cluster --> Pod("<div style='text-align:left; margin:0px;'>apiVersion:&nbsp;v1<br/>kind: Pod<br/>metadata:<br/>&nbsp;&nbsp;name: my-pod<br/></div>")
```

If your kube-context points to the platform'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, the platform will add a special annotation to each ingress that will track activity and reset the timer when a request is made to that ingress.
For [ingress-nginx](https://github.com/kubernetes/ingress-nginx/tree/main) based Ingresses and [Istio](https://istio.io/) Gateways, activity detection works automatically.
For nginx based ingresses, the platform adds the [mirror-target](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md#mirror) annotation to each ingress that will track activity and reset the timer when a request is made to that ingress.
For Istio, the metrics from the istio-proxy container are used to determine activity.

<br></br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,16 @@ flowchart LR;
Platform("vCluster Platform")

Platform --> Cluster("Connected Cluster <br/> Kubernetes API Server")
Cluster --> Pod("apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: my-pod<br/>...")

class kubectl code
class Pod yaml
class Platform platform
Cluster --> Pod("<div style='text-align:left; margin:0px;'>apiVersion:&nbsp;v1<br/>kind: Pod<br/>metadata:<br/>&nbsp;&nbsp;name: my-pod<br/></div>")
```

If your kube-context points to the platform'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, the platform will add a special annotation to each ingress that will track activity and reset the timer when a request is made to that ingress.
For [ingress-nginx](https://github.com/kubernetes/ingress-nginx/tree/main) based Ingresses and [Istio](https://istio.io/) Gateways, activity detection works automatically.
For nginx based ingresses, the platform adds the [mirror-target](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md#mirror) annotation to each ingress that will track activity and reset the timer when a request is made to that ingress.
For Istio, the metrics from the istio-proxy container are used to determine activity.

<br></br>

Expand Down
Loading