Skip to content

Commit 1f92aa6

Browse files
committed
correct virtual cluster instance references and clear up Ingress and Istio verbiage
Signed-off-by: Ryan Swanson <[email protected]>
1 parent ca9eef8 commit 1f92aa6

File tree

11 files changed

+346
-239
lines changed

11 files changed

+346
-239
lines changed

platform/_partials/sleep/activity-detection.mdx

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,23 @@ env:
1616
1717
All virtual cluster Kubernetes API requests that are made through the platform count as activity in the {props.name}.
1818
19-
20-
<!-- vale off -->
2119
```mermaid
2220
flowchart LR;
2321
kubectl("<code>$ kubectl get pod my-pod</code>") --> Platform
2422

2523
Platform("vCluster Platform")
2624

2725
Platform --> Cluster("Connected Cluster <br/> Kubernetes API Server")
28-
Cluster --> Pod("apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: my-pod<br/>...")
29-
30-
class kubectl code
31-
class Pod yaml
32-
class Platform platform
26+
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>")
3327
```
34-
<!-- vale on -->
3528
3629
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.
3730

3831
### Ingress Requests
3932

40-
For ingress-nginx based ingresses and Istio Gateways with Virtual Services, activity detection also works automatically. Other ingress and gateway 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.
41-
For Istio, the VirtualServices are modified to respond to activity when put to sleep and restored upon waking.
33+
For [ingress-nginx](https://github.com/kubernetes/ingress-nginx/tree/main) based Ingresses and [Istio](https://istio.io/) Gateways, activity detection works automatically.
34+
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.
35+
For Istio, the metrics from the istio-proxy container are used to determine activity.
4236

4337
<br></br>
4438

platform_versioned_docs/version-4.3.0/_partials/sleep/activity-detection.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,21 @@ flowchart LR;
88
Platform("vCluster Platform")
99
1010
Platform --> Cluster("Connected Cluster <br/> Kubernetes API Server")
11-
Cluster --> Pod("apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: my-pod<br/>...")
12-
13-
class kubectl code
14-
class Pod yaml
15-
class Platform platform
11+
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>")
1612
```
1713

1814
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.
1915

2016
### Ingress Requests
2117

22-
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.
18+
For [ingress-nginx](https://github.com/kubernetes/ingress-nginx/tree/main) based Ingresses and [Istio](https://istio.io/) Gateways, activity detection works automatically.
19+
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.
20+
For Istio, the metrics from the istio-proxy container are used to determine activity.
2321

2422
<br></br>
2523

2624
:::info Ingress Wakeup
2725

2826
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}.
2927

30-
:::
28+
:::

platform_versioned_docs/version-4.4.0/_partials/sleep/activity-detection.mdx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,16 @@ flowchart LR;
2424
Platform("vCluster Platform")
2525

2626
Platform --> Cluster("Connected Cluster <br/> Kubernetes API Server")
27-
Cluster --> Pod("apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: my-pod<br/>...")
28-
29-
class kubectl code
30-
class Pod yaml
31-
class Platform platform
27+
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>")
3228
```
3329
3430
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.
3531

3632
### Ingress Requests
3733

38-
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.
34+
For [ingress-nginx](https://github.com/kubernetes/ingress-nginx/tree/main) based Ingresses and [Istio](https://istio.io/) Gateways, activity detection works automatically.
35+
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.
36+
For Istio, the metrics from the istio-proxy container are used to determine activity.
3937

4038
<br></br>
4139

platform_versioned_docs/version-4.5.0/_partials/sleep/activity-detection.mdx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,16 @@ flowchart LR;
2424
Platform("vCluster Platform")
2525

2626
Platform --> Cluster("Connected Cluster <br/> Kubernetes API Server")
27-
Cluster --> Pod("apiVersion: v1<br/>kind: Pod<br/>metadata:<br/> name: my-pod<br/>...")
28-
29-
class kubectl code
30-
class Pod yaml
31-
class Platform platform
27+
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>")
3228
```
3329
3430
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.
3531

3632
### Ingress Requests
3733

38-
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.
34+
For [ingress-nginx](https://github.com/kubernetes/ingress-nginx/tree/main) based Ingresses and [Istio](https://istio.io/) Gateways, activity detection works automatically.
35+
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.
36+
For Istio, the metrics from the istio-proxy container are used to determine activity.
3937

4038
<br></br>
4139

0 commit comments

Comments
 (0)