Skip to content

Commit

Permalink
remove old install k8s doc (#1091)
Browse files Browse the repository at this point in the history
* remove old install k8s doc

Signed-off-by: R-Lawton <[email protected]>

* fix 404 links

Signed-off-by: R-Lawton <[email protected]>

---------

Signed-off-by: R-Lawton <[email protected]>
  • Loading branch information
R-Lawton authored Dec 20, 2024
1 parent a4876c5 commit f4c487b
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 237 deletions.
209 changes: 0 additions & 209 deletions doc/install/install-kubernetes.md

This file was deleted.

3 changes: 0 additions & 3 deletions doc/install/install-make.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
## Overview
The following doc will show you how to install the Kuadrant Operator using make targets in the Kuadrant operator repo. What will be installed is Istio, Kubernetes Gateway API and Kuadrant itself.

For other methods of installation see
- [k8s](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-kubernetes.md)
- [Openshift](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-openshift.md)

> **Note:** In production environment, these steps are usually performed by a cluster operator with administrator privileges over the Kubernetes cluster.
Expand Down
4 changes: 2 additions & 2 deletions doc/install/mtls-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ At the time of writing there is [an RFC](https://github.com/Kuadrant/architectur

## Prerequisites

You have installed Kuadrant in a [Kubernetes](https://docs.kuadrant.io/latest/kuadrant-operator/doc/install/install-kubernetes/) or [OpenShift](https://docs.kuadrant.io/latest/kuadrant-operator/doc/install/install-openshift/) cluster.
Additionally, you have at least 1 AuthPolicy or RateLimitPolicy attached to your Gateway or HTTPRoute.
- You have installed Kuadrant in a Kubernetes cluster.
- Additionally, you have at least 1 AuthPolicy or RateLimitPolicy attached to your Gateway or HTTPRoute.

## Enabling mTLS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ Topology:

## Setup the environment

Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc.

Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc.

### Deploy the Toy Store sample application (Persona: _App developer_)

Expand Down
2 changes: 1 addition & 1 deletion doc/user-guides/dns/gateway-dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This user guide walks you through an example of how to configure DNS for all rou

### Setup the environment

Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc.
Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc.

Create a namespace:

Expand Down
3 changes: 1 addition & 2 deletions doc/user-guides/full-walkthrough/secure-protect-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ This guide walks you through using Kuadrant to secure, protect, and connect an A

## Prerequisites

- Have a cluster with Kuadrant operator installed.
- Either [Kubernetes installation guide](../../install/install-kubernetes.md) or [Openshift installation guide](../../install/install-openshift.md)
- Kubernetes cluster with Kuadrant operator installed.
- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) command line tool.
- AWS/Azure or GCP with DNS capabilities.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Authenticated Rate Limiting for Application developers
For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas)

For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas)

This user guide walks you through an example of how to configure authenticated rate limiting for an application using Kuadrant.

Expand All @@ -20,7 +21,7 @@ We will define 2 users of the API, which can send requests to the API at differe

### Setup the environment

Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc.
Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc.

### Deploy the Toy Store API

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Each user will be entitled to a maximum of 5rp10s (5 requests every 10 seconds).

### Setup the environment

Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc.
Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc.

### Deploy the Toystore example API:

Expand Down Expand Up @@ -274,7 +274,7 @@ curl -H "Authorization: Bearer $SA_TOKEN" -H 'Host: api.toystore.com' -X POST ht
# HTTP/1.1 403 Forbidden
```

### Enforce rate limiting on requests to the Toy Store API
### Enforce rate limiting on requests to the Toy Store API

Create a Kuadrant `RateLimitPolicy` to configure rate limiting:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Gateway Rate Limiting for Cluster Operators

For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas)
For more info on the different personas see [Gateway API](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/#key-roles-and-personas)

This user guide walks you through an example of how to configure rate limiting for all routes attached to a specific ingress gateway.


### Setup the environment

Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc.
Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc.

### Deploy the Toystore example API:

```sh
kubectl apply -f examples/toystore/toystore.yaml

```

### Create the ingress gateways

```sh
Expand Down
8 changes: 3 additions & 5 deletions doc/user-guides/ratelimiting/multi-auth-rlp-diff-section.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This user guide walks you through an example of how to configure multiple rate l

### Setup the environment

Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc.
Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc.

### Deploy the sample API:

Expand Down Expand Up @@ -80,7 +80,7 @@ spec:
name: environment
sectionName: external
defaults:
strategy: merge
strategy: merge
limits:
"external":
rates:
Expand All @@ -104,7 +104,7 @@ spec:
name: environment
sectionName: local
defaults:
strategy: merge
strategy: merge
limits:
"local":
rates:
Expand All @@ -115,8 +115,6 @@ EOF

> **Note:** It may take a couple of minutes for the RateLimitPolicy to be applied depending on your cluster.


### Verify the rate limiting works by sending requests in a loop

Expose the gateways, respectively at the port numbers `9081` and `9082` of the local host:
Expand Down
7 changes: 4 additions & 3 deletions doc/user-guides/ratelimiting/multi-auth-rlp-same-section.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ We will define 2 users of the API, which can send requests to the API at differe

### Setup the environment

Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make-target.md) to set up your environment before continuing with this doc.
Follow this [setup doc](https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/install/install-make.md) to set up your environment before continuing with this doc.

### Deploy the Toy Store API

Expand Down Expand Up @@ -55,7 +55,7 @@ spec:
method: GET
backendRefs:
- name: toystore
port: 80
port: 80
EOF
```

Expand Down Expand Up @@ -168,9 +168,10 @@ EOF

### Enforce authenticated rate limiting on requests to the Toy Store API

Create Kuadrant `RateLimitPolicy's` to configure rate limiting for Bob and Alice:
Create Kuadrant `RateLimitPolicy's` to configure rate limiting for Bob and Alice:

### Bob

```sh
kubectl apply -f - <<EOF
apiVersion: kuadrant.io/v1beta3
Expand Down
Loading

0 comments on commit f4c487b

Please sign in to comment.